1
0
mirror of https://github.com/billz/raspap-webgui.git synced 2023-10-10 13:37:24 +02:00

Updated Quick Installer usage (markdown)

Bill Zimmerman 2019-11-27 11:51:47 +01:00
parent 7a8101eead
commit a8b08d0738

@ -9,16 +9,16 @@ Appending `-s -- [OPTION]` to the Quick Install directive will activate one or m
#### -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.
#### -o, --openvpn <flag>
#### -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.
#### -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](https://github.com/billz/raspap-webgui/wiki/SSL-certificates-(Quick-Installer)).
#### -r, --repo, --repository <name>
#### -r, --repo, --repository `<name>`
If you have forked this project to your own GitHub repo, this option lets you override the default GitHub repo (`billz/raspap-webgui`) used to install RaspAP. An alternate repository name is a required parameter.
#### -b, --branch <name>
#### -b, --branch `<name>`
Similarly, this option overrides the default git branch (`master`). 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 two options is given below: