mirror of
https://codeberg.org/vegvisir/install.git
synced 2025-09-13 16:23:42 +02:00
vlw
ce6d7fae60
Reviewed-on: https://codeberg.org/vegvisir/install/pulls/8 Co-authored-by: vlw <victor@vlw.se> Co-committed-by: vlw <victor@vlw.se>
40 lines
No EOL
1.4 KiB
Markdown
40 lines
No EOL
1.4 KiB
Markdown
# Vegvisir installer
|
|
Run this script from a git repository to automatically install and configure Vegvisir as a git submodule to your project.
|
|
|
|
> [!IMPORTANT]
|
|
> The script will only run in environments with Bash and `coreutils` installed (for now).
|
|
|
|
# Get started
|
|
1. Create a git repository for your project.
|
|
2. Run this command from the root directory of your local repository.
|
|
|
|
```sh
|
|
curl -fsSL https://codeberg.org/vegvisir/install/raw/branch/master/install.sh | bash
|
|
```
|
|
|
|
# Arguments
|
|
You can pass optional named arguments to this script for headless installation of Vegvisir.
|
|
|
|
### `--install` - Don't install, only configure Vegvisir
|
|
```sh
|
|
./install.sh --install=n
|
|
```
|
|
Pass `--install=n` to prevent download and installation of the Vegvisir git submodule. Use this option if you're version controlling Vegvisir from your project repository.
|
|
|
|
### `--dir` - Installation directory
|
|
```sh
|
|
./install.sh --dir="/path/to/project"
|
|
```
|
|
Pass a `--dir` argument with a value of a directory Vegvisir should consider its [`root_path`](https://vegvisir.vlw.se/docs/Reference/Env#root_path).
|
|
|
|
### `--overwrite` - Overwrite configuration files
|
|
```sh
|
|
./install.sh --overwrite=y
|
|
```
|
|
Pass `--overwrite=y` to replace existing Vegvisir configuration files.
|
|
|
|
### `--example` - Generate example website
|
|
```sh
|
|
./install.sh --example=n
|
|
```
|
|
Pass `--overwrite=n` to disable generation of an example website after installation. |