backups: clarify backup of config file

[NicolasCARPi]

see: elabftw/elabctl#45 (comment)

Summary by CodeRabbit

• Documentation
  • Clarified which backup types are managed (databases and uploaded files) and which are intentionally excluded.
  • Added explicit note that configuration files (containing secrets) are not backed up and may require manual restoration.
  • Added guidance on handling secret re-encryption and explained data impact when configuration values are lost.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9bf30f5 and 5f6ff54.

📒 Files selected for processing (1)

• docs/install/backups.md

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/install/backups.md

---

Walkthrough

This update revises backup documentation to state elabctl now manages MySQL (via mysqldump) and uploaded-file backups (via borgbackup), while explicitly noting the configuration file is intentionally not backed up due to secrets and may require secret re-encryption if lost.

Changes

Cohort / File(s)	Summary
Backup Documentation docs/install/backups.md	Clarifies that elabctl manages MySQL and uploaded-file backups; explicitly states the configuration file is not backed up because it contains secrets. Adds guidance about potential re-encryption of secrets (e.g., SECRET_KEY, DB_PASSWORD) and that losing config values does not affect stored data integrity.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

Make it so: backups steady, guarded tight,
elabctl holds the helm through day and night,
Secrets kept separate, locked from sight,
Config left aside — deliberate, right,
Data remains safe beneath the light.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and accurately summarizes the main change: clarifying backup procedures for the configuration file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch nico-260301-backupsdoc

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/install/backups.md`:
- Around line 20-22: Fix the wording in the backup guidance: replace "backuped"
with "backed up", change "responsible from handling backups" to "responsible for
handling backups", add a space in "values(such as" to "values (such as", and
tighten the paragraph around SECRET_KEY/SMTP/TSA to be clearer and more concise
while preserving the meaning that configuration files are not included in data
backups and that SMTP/TSA passwords must be re-encrypted with a new SECRET_KEY
upon restore.

---

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 807af2a and 9bf30f5.

📒 Files selected for processing (1)

• docs/install/backups.md