Skip to content

Commit 2969b4e

Browse files
author
Rob Frawley 2nd
committed
updated README.md
1 parent 33a7324 commit 2969b4e

File tree

1 file changed

+13
-34
lines changed

1 file changed

+13
-34
lines changed

README.md

Lines changed: 13 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,54 +5,33 @@ This repository contains a collection of helper scripts specifically created and
55
The included scripts, including a basic description of their use, is as follows:
66

77
- `dl/`
8-
- `update-geolitecity-db.bash`
9-
Useful as a stand-alone command or a cron job to update youu GeoLite database.
8+
- `update-geolitecity-db.bash`: Useful as a stand-alone command or a cron job to update youu GeoLite database.
109

1110
- `gitlab/`
12-
- `backup-config.bash`
13-
Called by rsnapshot to backup the current GitLab config each time a new
11+
- `backup-config.bash`: Called by rsnapshot to backup the current GitLab config each time a new
1412
snapshot is created.
1513

1614
- `monit/`
17-
- `check-uwf.bash`
18-
Called by monit to determine the status of UFW. Returns a simple status string
15+
- `check-uwf.bash`: Called by monit to determine the status of UFW. Returns a simple status string
1916
and an exit value describing the firewall's up or down state.
2017

2118
- `mysql/`
22-
- `backup-databases-as-hot.bash`
23-
Uses innobackupex to perform an on-line (hot) backup of MySQL.
24-
- `backup-databases-to-sql.bash`
25-
Uses mysqldump to perform an SQL backup of each database (used as an rsnapshot
26-
backup_script during a snapshot run).
27-
- `mysql-defragment.bash`
28-
Runs through all MySQL tables, attempts to determine fragmentation state, and
29-
runs the native defragment command on each table deemed fragmented.
30-
- `perform-gstorage-bashup.bash`
31-
Wrapper around `backup-databases-as-hot.bash` and `backup-databases-to-
32-
sql.bash` that then uses Google Cloud storage to upload the resulting hot and
33-
SQL-based backups.
19+
- `backup-databases-as-hot.bash`: Uses innobackupex to perform an on-line (hot) backup of MySQL.
20+
- `backup-databases-to-sql.bash`: Uses mysqldump to perform an SQL backup of each database (used as an rsnapshot backup_script during a snapshot run).
21+
- `mysql-defragment.bash`: Runs through all MySQL tables, attempts to determine fragmentation state, and runs the native defragment command on each table deemed fragmented.
22+
- `perform-gstorage-bashup.bash`: Wrapper around `backup-databases-as-hot.bash` and `backup-databases-to-sql.bash` that then uses Google Cloud storage to upload the resulting hot and SQL-based backups.
3423

3524
- `piwik/`
36-
- `piwik-import-nginx-logs.bash`
37-
Wrapper around Piwik's `import_logs.py` that allows for the command to fail (as it often does) and then continues the import at the last offset.
25+
- `piwik-import-nginx-logs.bash`: Wrapper around Piwik's `import_logs.py` that allows for the command to fail (as it often does) and then continues the import at the last offset.
3826

3927
- `rsnapshot/`
40-
- `rsnapshot-plugin-btrfs-cp.sh`
41-
Can be used as an alternative to `rsnapshot`'s native `cp` command on `btrfs`
42-
filesystems (not well-tested; use with caution).
43-
- `rsnapshot-plugin-btrfs-rm.sh`
44-
Can be used as an alternative to `rsnapshot`'s native `rm` command on `btrfs`
45-
filesystems (not well-tested; use with caution).
28+
- `rsnapshot-plugin-btrfs-cp.sh`: Can be used as an alternative to `rsnapshot`'s native `cp` command on `btrfs` filesystems (not well-tested; use with caution).
29+
- `rsnapshot-plugin-btrfs-rm.sh`: Can be used as an alternative to `rsnapshot`'s native `rm` command on `btrfs` filesystems (not well-tested; use with caution).
4630

4731
- `system/`
48-
- `restart-network-interfaces.bash`
49-
With the removal of `/etc/init.d/networking` as a useful means of bringing the
50-
network `up`/`down` on Ubuntu versions after `12.10`, this script brings back
51-
that functionality in an SSH-safe manner.
52-
- `security-check-users-and-groups.bash`
53-
Validates that users and groups are correctly implemented in shadow files.
54-
- `toggle-web-maintenance-mode.bash`
55-
Toggles our website between a maintensnace mode and an online mode.
32+
- `restart-network-interfaces.bash`: With the removal of `/etc/init.d/networking` as a useful means of bringing the network `up`/`down` on Ubuntu versions after `12.10`, this script brings back that functionality in an SSH-safe manner.
33+
- `security-check-users-and-groups.bash`: Validates that users and groups are correctly implemented in shadow files.
34+
- `toggle-web-maintenance-mode.bash`: Toggles our website between a maintensnace mode and an online mode.
5635

5736
## License
5837

0 commit comments

Comments
 (0)