diff --git a/Quick-Installer-usage.md b/Quick-Installer-usage.md new file mode 100644 index 0000000..b83ddb2 --- /dev/null +++ b/Quick-Installer-usage.md @@ -0,0 +1,27 @@ +The [Quick Installer](https://github.com/billz/raspap-webgui/blob/master/installers/raspbian.sh) has several options for configuring a RaspAP installation. You can retrieve usage notes by requesting the installer like so: + +``` +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 in detail below. + +#### -y, --yes, --assume-yes +This option enables unattended installations, such that the installer assumes "yes" as an answer to all user prompts. + +#### -o, --openvpn +Used with the `-y`, `--yes` option above, this sets the OpenVPN install option (`0` = don't install OpenVPN). + +#### -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 +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 +Similarly, this option overrides the default git branch (master). This is useful if you have created a feature branch (`my-great-feature`) and wish to test an installation using the Quick Installer. The alternate branch name is a required parameter. + +An example combining the two options is given below: +``` +curl -sL https://install.raspap.com | bash -s -- --repo billz/my-other-repo --branch my-great-feature +```