From f690583a067b3cef09d14981d30ec6364a74a8cf Mon Sep 17 00:00:00 2001 From: Brandon Rodriguez <brodriguez8774@gmail.com> Date: Sat, 13 Mar 2021 09:20:15 -0500 Subject: [PATCH] Update documentation --- general/update_permissions.sh | 11 +++++++++++ readme.md | 20 ++++++++++++++++++++ 2 files changed, 31 insertions(+) diff --git a/general/update_permissions.sh b/general/update_permissions.sh index 2c830aa..6bb5854 100755 --- a/general/update_permissions.sh +++ b/general/update_permissions.sh @@ -1,6 +1,17 @@ #!/usr/bin/env bash ### # Updates permissions such that "user" and "group" owners are able to access, and "other" uses cannot access. + # + # For security, sudo access is required. + # Script does not make any changes to file ownership. + # + # + # Required Args: + # * Directory to Run On + # + # + # https://git.brandon-rodriguez.com/scripts/bash/server_management + # Version 1.0 ## diff --git a/readme.md b/readme.md index b0e1414..fec397e 100644 --- a/readme.md +++ b/readme.md @@ -4,6 +4,8 @@ ## Description Various scripts to help with management of servers. Most centered around data backups and related maintenance. +Project located at # https://git.brandon-rodriguez.com/scripts/bash/server_management + ## Provided Scripts @@ -15,5 +17,23 @@ Updates permissions such that "user" and "group" owners are able to access, and Takes in exactly one arg, consisting of the path to either a file or directory to adjust permissions of. + ### Backups Various scripts related to backing up + maintenance of databases or files. + +#### Backup Mysql +Backups up provided database to a file, with a consistent naming scheme. + +#### Clear Backups +Clears out any files in directory that match backup naming scheme. + +Note that files are cleared out dynamically, based on date. + +#### Generate Test Backup Files +Generates a whole set of empty testing files which match the backup naming scheme. + +Used in testing the "clear backups" script. + + +## References +See `documents/references.md`. -- GitLab