kakifilem
/
pg-r2-backup
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: clarify database configuration

This commit is contained in:
BigDaddyAman 2026-02-01 20:30:08 +08:00
parent c83070b0c1
commit 38683e18ce
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -19,7 +19,7 @@ Designed specifically as a **Railway deployment template**, with built-in suppor
- 🔐 **Optional Encryption** — gzip compression or 7z encryption with password - 🔐 **Optional Encryption** — gzip compression or 7z encryption with password
- ☁️ **Cloudflare R2 Integration** — seamless S3-compatible storage support - ☁️ **Cloudflare R2 Integration** — seamless S3-compatible storage support
- 🧹 **Retention Policy** — automatically delete old backups - 🧹 **Retention Policy** — automatically delete old backups
- 🔗 **Flexible Database URLs** — supports private and public PostgreSQL URLs - 🔗 **Flexible Database URLs** — supports private and public PostgreSQL connection URLs
- ⚡ **Optimized Performance** — parallel pg_dump and multipart S3 uploads - ⚡ **Optimized Performance** — parallel pg_dump and multipart S3 uploads
- 🐳 **Docker Ready** — portable, lightweight container - 🐳 **Docker Ready** — portable, lightweight container
- 🚀 **Railway Template First** — no fork required for normal usage - 🚀 **Railway Template First** — no fork required for normal usage
@ -109,6 +109,9 @@ You can configure the backup schedule using **Railway Cron Jobs**:
- Use https://crontab.guru to validate expressions - Use https://crontab.guru to validate expressions
- Adjust `MAX_BACKUPS` to match your schedule - Adjust `MAX_BACKUPS` to match your schedule
> If you use Railway Cron Jobs, the service will start once per execution.
> In this case, the internal scheduler is ignored after startup.
--- ---
## 🖥️ Running Locally or on Other Platforms ## 🖥️ Running Locally or on Other Platforms
@ -207,6 +210,12 @@ Fork this repository **only if you plan to**:
--- ---
## ❓ FAQ
**Why only DATABASE_URL?**
This matches how most modern platforms expose PostgreSQL credentials.
Support for separate DB variables may be added if there is demand.
## 📜 License ## 📜 License
This project is open source under the **MIT License**. This project is open source under the **MIT License**.