feat: updates readme to include automated installation instructions.
This commit is contained in:
27
README.md
27
README.md
@@ -30,6 +30,26 @@ Once that is done:
|
|||||||
1. Reload the daemon `sudo systemctl daemon-reload`
|
1. Reload the daemon `sudo systemctl daemon-reload`
|
||||||
1. Mount the folder `sudo mount -a`
|
1. Mount the folder `sudo mount -a`
|
||||||
|
|
||||||
|
### Automated Installation Script
|
||||||
|
|
||||||
|
This repository has an automated installation script that can be ran.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo su -c "bash <(wget -qO- https://git.housh.dev/homelab/backup/raw/branch/main/install.sh)" root
|
||||||
|
```
|
||||||
|
|
||||||
|
## Manual Installation
|
||||||
|
|
||||||
|
See [installation
|
||||||
|
script](https://git.housh.dev/homelab/backup/src/branch/main/install.sh).
|
||||||
|
|
||||||
|
### Setup the backup script
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo wget "https://git.housh.dev/homelab/backup/raw/branch/main/docker-backup.sh" -O /usr/local/bin/docker-backup
|
||||||
|
sudo chmod +x /usr/local/bin/docker-backup
|
||||||
|
```
|
||||||
|
|
||||||
### Systemd Setup
|
### Systemd Setup
|
||||||
|
|
||||||
Setup the systemd service and timer, so that backups are ran once a day @ 3 a.m.
|
Setup the systemd service and timer, so that backups are ran once a day @ 3 a.m.
|
||||||
@@ -44,13 +64,6 @@ sudo systemctl start backup.service
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Setup the backup script
|
|
||||||
|
|
||||||
1. Download the script `wget https://git.housh.dev/homelab/backup/raw/branch/main/docker-backup.sh`
|
|
||||||
1. Add any extra volumes to backup.
|
|
||||||
1. Make script executable `chmod +x docker-backup.sh`
|
|
||||||
1. Manually run the script `sudo ./docker-backup.sh`
|
|
||||||
|
|
||||||
## Restore
|
## Restore
|
||||||
|
|
||||||
This repository also contains a restore script that can restore the stacks and
|
This repository also contains a restore script that can restore the stacks and
|
||||||
|
|||||||
Reference in New Issue
Block a user