readme: updated headings for compliance with best practices
This commit is contained in:
		
							parent
							
								
									e166086f91
								
							
						
					
					
						commit
						3926699007
					
				
							
								
								
									
										10
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								README.md
									
									
									
									
									
								
							| @ -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 | ||||
| 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 | ||||
| running it otherwise.  This is because NextCloud's OCC command (needed to put | ||||
| @ -162,7 +162,7 @@ order: | ||||
|     7. purge timeframe options | ||||
|     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, | ||||
| 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 | ||||
| not run borg locally but your backups/restores will be slower. | ||||
| 
 | ||||
| ### Examples: | ||||
| ### Examples | ||||
| 
 | ||||
| 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. | ||||
| @ -299,7 +299,7 @@ pAsSwOrD | ||||
| nextcloudDB | ||||
| ``` | ||||
| 
 | ||||
| ### Protect this file! | ||||
| ### Protect your sql details file | ||||
| 
 | ||||
| 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 | ||||
| @ -446,7 +446,7 @@ level as follows: | ||||
| A detailed breakdown of the files and all options are included in a separate | ||||
| 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 | ||||
| large over time.  This is especially true if you are using verbose output from | ||||
|  | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user