asif/NextCloudBackup
1
0
Fork 0
Code Issues Pull Requests Releases 2 Activity

readme: root req and parameter intro

Browse Source
This commit is contained in:
Asif Bacchus 2018-10-19 03:19:54 -06:00
parent cd82af7d6f
commit 19eec37ed3
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -30,5 +30,18 @@ it requires to function. In addition, it reads external files for SQL and borg
settings, so you don't have to weed through the script code to supply things
like passwords.
## Why root?
This script must be run by the root user and will exit with an error if you try
running it otherwise. This is because NextCloud's OCC command (needed to put
NextCloud into maintenance mode) must be run as the web-user account and only
the root account can switch users without needing to stop and ask for
permission/passwords.
## Script parameters
You can run the script with the *'-?'* parameter to access the built-in help
which explains the parameters. However, the following is more detailed
explanation of each parameter and how to use them:
### Required parameters