Skip to content

Commit 73bc342

Browse files
authored
backups: clarify backup of config file (#2)
1 parent 807af2a commit 73bc342

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

docs/install/backups.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,13 @@ This page documents how to backup an existing eLabFTW installation. It is import
1313

1414
There are basically three things to backup:
1515

16-
- The MySQL database (by default in `/var/elabftw/mysql`)
17-
- The uploaded files (by default in `/var/elabftw/web`)
18-
- Your configuration file (by default `/etc/elabftw.yml`)
16+
- The MySQL database (by default in `/var/elabftw/mysql`) => handled by `elabctl` through `mysqldump`
17+
- The uploaded files (by default in `/var/elabftw/web`) => handled by `elabctl` through `borgbackup`
18+
- Your configuration file (by default `/etc/elabftw.yml`) => **NOT** handled by `elabctl` on purpose, read below
19+
20+
Important note: the configuration file is **NOT** backed up along with the data. This is done to avoid bundling secrets (such as the `SECRET_KEY` bundled with the data). You are responsible from backing up your configuration values (such as database password/IP/bind-mounted folders/ENV vars). This is kept separate on purpose. We highly recommend using configuration management tools such as `ansible` to manage this aspect.
21+
22+
Note that in the event where you lose your configuration values, this will not impact your data. Only the SMTP password and optional TSA password will need to be re-encrypted with a new `SECRET_KEY`. And when redeploying, you will use a different `DB_PASSWORD`, but this has no impact on the actual data. As such, configuration values are not critical to the integrity of your backups.
1923

2024
## How to backup a Docker installation
2125

0 commit comments

Comments
 (0)