Docs / confidence in backup-bot-two #74

New Issue

2025-10-07T11:14:16Z

decentral1se commented

2025-10-07 11:14:16 +00:00

me and @p4u1 were chatting about this and saying that we kind of don't understand what it does exactly. This produces various levels of reluctance to commit to using the tool. Maybe others have this feeling? Ofc we can read the code but docs would be nicer! what are the guarantees / failure models / advantages / safeguards / etc. of backup-bot-two. I know many collectives are using it happily and it's stable.

me and @p4u1 were chatting about this and saying that we kind of don't understand what it does exactly. This produces various levels of reluctance to commit to using the tool. Maybe others have this feeling? Ofc we can read the code but docs would be nicer! what are the guarantees / failure models / advantages / safeguards / etc. of `backup-bot-two`. I know many collectives are using it happily and it's stable.

linnealovespie commented

2025-10-10 02:57:55 +00:00

Echoing the need for more thorough documentation! I'm trying to deploy backup-bot-two for RTM recipes and as someone who's not an expert, the instructions are hard to parse.

3wordchant commented

2025-10-10 18:34:33 +00:00

I can speak to why I (very reluctantly) made backup-bot-two in the first place: I needed a backup system that:

Automatically backs things up based on Docker labels (i.e. doesn't need manual configuration every time you add a new app)
Supports running pre- and post-backup commands; every other automatic Docker backup system I found was handling backing up databases either by shutting down database servers before backups, or just YOLOing and hoping that copying the data directory of a running database server will produce a consistent backup (it won't). backup-bot-two instead supports doing the (imo) only correct thing, of running mariadb-dump / pg_dump

File under "advantages" I guess

I can speak to why I (very reluctantly) made backup-bot-two in the first place: I needed a backup system that: - Automatically backs things up based on Docker labels (i.e. doesn't need manual configuration every time you add a new app) - Supports running pre- and post-backup commands; every other automatic Docker backup system I found was handling backing up databases either by shutting down database servers before backups, or just YOLOing and hoping that copying the data directory of a running database server will produce a consistent backup (it won't). `backup-bot-two` instead supports doing the (imo) only correct thing, of running `mariadb-dump` / `pg_dump` File under "advantages" I guess

decentral1se referenced this issue from toolshed/abra

2025-10-28 12:16:33 +00:00

distroless container issues #707

moritz commented

2026-03-24 22:46:11 +00:00

You're absolutely right. writing docs and refactoring the code is way too long on my todo list 🙈
It started as little script around restic and it has grown and grown...

You're absolutely right. writing docs and refactoring the code is way too long on my todo list 🙈 It started as little script around restic and it has grown and grown...

❤️ 1

3wordchant commented

2026-03-25 00:10:24 +00:00

Someone at the last NYC Co-op Cloud Convergence introduced me to https://diataxis.fr/; they were suggesting it as a possible structure for the README.

👀 1

3wordchant referenced this issue

2026-04-11 21:05:35 +00:00

Rename to backup-bot? #89

Sign in to join this conversation.

4 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: coop-cloud/backup-bot-two#74