Update scripts/README.md
All checks were successful
Deploy / Deploy (push) Successful in 2m24s

This commit is contained in:
2026-02-23 09:05:05 +00:00
parent ffec069801
commit 11128897bc

View File

@@ -13,6 +13,7 @@ Some scripts are desgined to by run **automatically**, while others are intended
| ------------- | ------- | ------------ |
| `init.sh` | Prepare Docker volumes and permissions | Automatically by the init container |
| `backup.sh` | Create and prune server backups | Automatically (e.g. cron/systemd) |
| `mark_daily_backup.sh` | Create/update daily backup marker | Automatically (e.g. cron/systemd) |
| `restore.sh` | Restore data from a backup | Manually |
| `setup.sh` | Configure gamerules, time, weather, gamemode | Manually |
| `creative` | Gamerule definitions for creative worlds | Read by `setup.sh` |
@@ -59,6 +60,23 @@ This script also handles **automatic pruning of old backups** once a configured
---
### `mark_daily_backup.sh`
**Purpose:**
Marks the latest backup as the daily backup.
This script maintains consistency between the two backup tiers: hourly and daily. Hourly backups are created by `backup.sh`, while daily backups are managed by Duplicati.
To prevent Duplicati from accessing a backup that is still in progress, this script updates an intermediate `daily` marker to point to the most recently completed hourly backup. By the time the scheduled daily job runs, the referenced backup is guaranteed to be complete.
**Execution**
- Intended to run automatically on a schedule
- Typically triggered by a **cron job** or **systemd timer**
- Must be run from the directory containing `compose.yml`
- Does not take any arguments
---
### `restore.sh`
**Purpose:**