Skip to content

Quick Installer usage

Bill Zimmerman edited this page Dec 5, 2019 · 15 revisions

The Quick Installer has several options for configuring a RaspAP installation. You can get usage notes from your command shell 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 below.

-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>

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.

-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>

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 repo and branch options is given below:

curl -sL https://install.raspap.com | bash -s -- --repo foo/bar --branch my-feature

-h, --help

Outputs these usage notes and exits.

-v, --version

Queries the Github API, outputs the latest RaspAP release version and exits.