Skip to content

Commit

Permalink
Document new install options, update examples
Browse files Browse the repository at this point in the history
  • Loading branch information
billz committed Nov 17, 2023
1 parent a63f111 commit bdd2e15
Showing 1 changed file with 36 additions and 12 deletions.
48 changes: 36 additions & 12 deletions docs/quick.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,27 @@ The [Quick installer](https://github.com/RaspAP/raspap-webgui/blob/master/instal
curl -sL https://install.raspap.com | bash -s -- --help
```

Appending `-s -- [OPTION]` to the Quick Install directive will activate one or more options. These are described below.
Appending `-s -- [option]` to the Quick Install directive will activate one or more options. Several options may be chained together to customize an installation. Examples are given below.

## Examples
The installer may be invoked locally or remotely via `curl`. Examples with both cases and various options are given below.

Invoke installer remotely, run non-interactively with option flags:
```
curl -sL https://install.raspap.com | bash -s -- --yes --openvpn 1 --adblock 0
curl -sL https://install.raspap.com | bash -s -- --yes --wireguard 1 --adblock 0
```

Invoke remotely, uprgrade an existing install to the [:octicons-heart-fill-24:{: .heart } Insiders Edition](insiders.md):
Invoke remotely, uprgrade an existing install to the [:octicons-heart-fill-24:{: .heart } Insiders Edition](insiders.md). The `--name` and `--token` arguments are optional; if they are not specified the user will be prompted to authenticate with GitHub:
```
curl -sL https://install.raspap.com | bash -s -- --upgrade --insiders
curl -sL https://install.raspap.com | bash -s -- --upgrade --insiders --name <name> --token <token>
```

Run locally specifying GitHub repo and branch:
Invoke remotely, perform an unattended update to the latest release version:
```
curl -sL https://install.raspap.com | bash -s -- --yes --update --path /var/www/html
```

Run locally specifying a GitHub repo and branch:
```
raspbian.sh --repo foo/bar --branch my/branch
```
Expand All @@ -41,6 +46,9 @@ raspbian.sh --version
#### -y, --yes, --assume-yes
This option enables unattended installations, such that the installer assumes "yes" as an answer to all user prompts. This behavior is identical to how the same option with the `apt-get` package handler works.

#### -c, --cert, --certificate
This option installs an SSL certificate with `mkcert` and configures lighttpd for HTTPS support. It does _not_ (re)install RaspAP. Details are [provided here](ssl.md).

#### -o, --openvpn `<flag>`
Used with the `-y`, `--yes` option above, this sets the OpenVPN install option (`0` = don't install OpenVPN). Given that OpenVPN support is an optional extra, this enables an unattended setup without installing it.

Expand All @@ -50,28 +58,44 @@ Used with the `-y`, `--yes` option above, this sets the Ad Blocking install opti
#### -w, --wireguard `<flag>`
Used with the `-y`, `--yes` option above, this sets the WireGuard install option (`0` = don't install WireGuard). Given that WireGuard support is an optional extra, this enables an unattended setup without installing it.

#### -c, --cert, --certificate
This option installs an SSL certificate with `mkcert` and configures lighttpd for HTTPS support. It does _not_ (re)install RaspAP. Details are [provided here](ssl.md).

#### -r, --repo, --repository `<name>`
If you have forked this project to your own GitHub repo, this option lets you override the default GitHub repo (`RaspAP/raspap-webgui`) used to install RaspAP. An alternate repository name is a required parameter.

#### -b, --branch `<name>`
Similarly, this option overrides the default git branch. This is useful if you have created a feature branch (`my-feature`) and wish to perform an installation using the Quick Installer. An alternate branch name is a required parameter.

An example combining the `repo` and `branch` options is given below:
An example combining the `-r`, `--repo` and `-b`, `--branch` options is given below:
```
curl -sL https://install.raspap.com | bash -s -- --repo foo/bar --branch my-feature
```

#### -t, --token `<accesstoken>`
Specify a [GitHub token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) to access a private repository.
Specify a GitHub [personal access token](https://docs.github.com/en/authentication/) to authenticate with a private repository. Used together with the `-n`, `--name` option (below).

#### -n, --name `<username>`
Specify a GitHub username to access a private repository. An example combining the `--token` and `--name` options is given below:

```
curl -sL https://install.raspap.com | bash -s -- --name billz --token [my-token]
```

#### -u, --upgrade
Upgrades an existing installation to the latest release version.
Upgrades an existing RaspAP installation to the latest release version.

#### -d, --update
Performs a minimal update of an existing installation to the [latest release version](https://github.com/RaspAP/raspap-webgui/releases). This differs from the `-u`, `--upgrade` option in several ways. The user is not prompted to install optional RaspAP components, and several steps used for an initial installation are not performed. Existing configuration files remain intact.

#### -p, --path
Sets the application path for an existing RaspAP installation.

It may be combined with the `-d`, `--update` and `-y`, `--yes` options to perform an unattended update. An example is given below:

```
curl -sL https://install.raspap.com | bash -s -- --update --path /var/www/html --yes
```

#### -i, --insiders
Installs from the [Insiders Edition](insiders.md) (`RaspAP/raspap-insiders`)
Installs from the [:octicons-heart-fill-24:{: .heart } Insiders Edition](insiders.md) (`RaspAP/raspap-insiders`).

#### -m, --minwrite
Configures a microSD card for [minimum write operation](minwrite.md).
Expand Down

0 comments on commit bdd2e15

Please sign in to comment.