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

readme: updated headings for compliance with best practices

Browse Source
This commit is contained in:
Asif Bacchus 2018-10-19 05:48:27 -06:00
parent e166086f91
commit 3926699007
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -38,7 +38,7 @@ 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 settings, so you don't have to weed through the script code to supply things
like passwords. like passwords.
## Why root? ## Why this script must be run as root
This script must be run by the root user and will exit with an error if you try 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 running it otherwise. This is because NextCloud's OCC command (needed to put
@ -162,7 +162,7 @@ order:
7. purge timeframe options 7. purge timeframe options
8. location of borg remote instance 8. location of borg remote instance
### Protect this file! ### Protect your borg details file
This file contains information on how to access and decrypt your borg repo, This file contains information on how to access and decrypt your borg repo,
therefore, you **must** protect it. You should lock it out to your root user. therefore, you **must** protect it. You should lock it out to your root user.
@ -234,7 +234,7 @@ another provider, you'll have to reference their locally installed copy of borg
relative to your repo path. You can also leave this blank if your provider does relative to your repo path. You can also leave this blank if your provider does
not run borg locally but your backups/restores will be slower. not run borg locally but your backups/restores will be slower.
### Examples: ### Examples
All fields including pointers to additional files to backup, exclusion patterns All fields including pointers to additional files to backup, exclusion patterns
and a remote borg path. Prune: keep all backups made in the last 14 days. and a remote borg path. Prune: keep all backups made in the last 14 days.
@ -299,7 +299,7 @@ pAsSwOrD
nextcloudDB nextcloudDB
``` ```
### Protect this file! ### Protect your sql details file
This file contains information on how to access your SQL installation therefore, This file contains information on how to access your SQL installation therefore,
you **must** protect it. You should lock it out to your root user. Putting it you **must** protect it. You should lock it out to your root user. Putting it
@ -446,7 +446,7 @@ level as follows:
A detailed breakdown of the files and all options are included in a separate A detailed breakdown of the files and all options are included in a separate
readme in the *'/etc/logwatch'* folder of this git archive. readme in the *'/etc/logwatch'* folder of this git archive.
### Remember to rotate your logs! ### Remember to rotate your logs
The log file generated by this script is fairly detailed so it can grow quite The log file generated by this script is fairly detailed so it can grow quite
large over time. This is especially true if you are using verbose output from large over time. This is especially true if you are using verbose output from