frodovdr/raspap-webgui
1
0
Fork 0
mirror of https://github.com/billz/raspap-webgui.git synced 2023-10-10 13:37:24 +02:00
Code Issues Releases Wiki Activity

Updated Quick Installer usage (markdown)

Bill Zimmerman 2019-12-01 10:57:21 +01:00
parent f3ec6accb5
commit 26c2d1acc3
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Quick-Installer-usage.md

@ -1,4 +1,4 @@
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:
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 these usage notes from your command shell by requesting the installer like so:
```
curl -sL https://install.raspap.com | bash -s -- --help
@ -21,7 +21,13 @@ If you have forked this project to your own GitHub repo, this option lets you ov
#### -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:
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
Outputs RaspAP release info and exits.