Fix formatting and headings in README.md

This commit is contained in:
hpz937
2025-11-04 13:52:06 -06:00
committed by GitHub
parent 6da12dfe0c
commit 1b435c9394

View File

@@ -39,13 +39,13 @@ It supports:
--- ---
## ⚙️ Installation ## Installation
1. **Copy script** 1. **Copy script**
```bash ```bash
sudo cp backup-to-b2.sh /usr/local/bin/ sudo cp backup-to-b2.sh /usr/local/bin/
sudo chmod +x /usr/local/bin/backup-to-b2.sh sudo chmod +x /usr/local/bin/backup-to-b2.sh
```` ```
2. **Create `/etc/restic/` directory** 2. **Create `/etc/restic/` directory**
@@ -103,27 +103,27 @@ It supports:
--- ---
## 🧰 Usage ## Usage
### 🔹 Run backup manually ### Run backup manually
```bash ```bash
sudo /usr/local/bin/backup-to-b2.sh run sudo /usr/local/bin/backup-to-b2.sh run
``` ```
### 🔹 Dry run (show what would be backed up) ### Dry run (show what would be backed up)
```bash ```bash
sudo /usr/local/bin/backup-to-b2.sh dry-run sudo /usr/local/bin/backup-to-b2.sh dry-run
``` ```
### 🔹 Clean staging (remove old tarballs) ### Clean staging (remove old tarballs)
```bash ```bash
sudo /usr/local/bin/backup-to-b2.sh clean sudo /usr/local/bin/backup-to-b2.sh clean
``` ```
### 🔹 Create encrypted config backup ### Create encrypted config backup
```bash ```bash
sudo /usr/local/bin/backup-to-b2.sh make-config-backup sudo /usr/local/bin/backup-to-b2.sh make-config-backup
@@ -131,7 +131,7 @@ sudo /usr/local/bin/backup-to-b2.sh make-config-backup
Creates `/var/backups/restic-config/restic-config-YYYYMMDD_HHMMSS.tar.gz.enc` Creates `/var/backups/restic-config/restic-config-YYYYMMDD_HHMMSS.tar.gz.enc`
### 🔹 Decrypt config backup ### Decrypt config backup
```bash ```bash
sudo /usr/local/bin/backup-to-b2.sh decrypt-config-backup /path/to/restic-config-2025XXXX.tar.gz.enc sudo /usr/local/bin/backup-to-b2.sh decrypt-config-backup /path/to/restic-config-2025XXXX.tar.gz.enc
@@ -143,13 +143,13 @@ Add `--restore` to overwrite `/etc/restic`, cron, and script:
sudo /usr/local/bin/backup-to-b2.sh decrypt-config-backup /path/to/file.enc --restore sudo /usr/local/bin/backup-to-b2.sh decrypt-config-backup /path/to/file.enc --restore
``` ```
### 🔹 Restore Docker volume from latest snapshot ### Restore Docker volume from latest snapshot
```bash ```bash
sudo /usr/local/bin/backup-to-b2.sh restore-volume-from-repo mariadb_data latest sudo /usr/local/bin/backup-to-b2.sh restore-volume-from-repo mariadb_data latest
``` ```
### 🔹 Restore plain tarball into volume ### Restore plain tarball into volume
```bash ```bash
sudo /usr/local/bin/backup-to-b2.sh restore-volume mariadb_data /var/backups/staging/volumes/mariadb_data.tar.gz sudo /usr/local/bin/backup-to-b2.sh restore-volume mariadb_data /var/backups/staging/volumes/mariadb_data.tar.gz
@@ -170,7 +170,7 @@ sudo /usr/local/bin/backup-to-b2.sh restore-volume mariadb_data /var/backups/sta
--- ---
## 🧪 Restore a fresh system ## Restore a fresh system
### 1: Install dependencies ### 1: Install dependencies
@@ -256,4 +256,4 @@ sudo tail -n 50 /var/log/backup/backup.log
## License ## License
MIT © 2025 MIT © 2025