Skip to content

Commit dd9a345

Browse files
authored
docs: backups contain sensitive secrets (#1376)
Signed-off-by: gruyaume <guillaume.belanger27@gmail.com>
1 parent a506870 commit dd9a345

5 files changed

Lines changed: 15 additions & 2 deletions

File tree

docs/how_to/backup_and_restore.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ Ella Core stores all persistent data in an embedded database. You can create bac
1212
2. Navigate to the **Backup and Restore** tab in the left-hand menu.
1313
3. Click on the **Backup** button.
1414
4. The backup file will be downloaded to your computer. Store this file in a safe location.
15-
15+
16+
!!! warning
17+
The backup archive contains sensitive secrets. Store and transfer it encrypted, and treat it as you would an admin credential.
18+
1619
!!! note
1720
This operation can also be done using the API. Please see the [backup API documentation](../reference/api/backup.md) for more information.
1821

docs/reference/api/backup.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ description: RESTful API reference for managing database backups.
66

77
This path creates a backup of the Ella Core database.
88

9+
The backup archive contains sensitive secrets. Store and transfer it encrypted, and treat it as you would an admin credential.
10+
911
## Create a Backup
1012

1113
| Method | Path |

docs/reference/production_hardening.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ This reference document provides guidelines for operating Ella Core in a product
1616
- **Set logging level to info**: Configure system logging level to `info` and use file output.
1717
- **Disable telemetry**: Disable telemetry in the configuration file.
1818
- **Rotate logs**: Implement log rotation for system and audit logs.
19-
- **Back up the database**: Back up the database file on a **daily** basis. Retain backups for at least **7 days**.
19+
- **Back up the database**: Back up the database file on a **daily** basis. Retain backups for at least **7 days**. Backup archives contain sensitive secrets; store and transfer them encrypted and treat them as admin credentials.
2020
- **Monitor metrics**: Operate an external Observability stack to collect and visualize metrics exposed by Ella Core.

internal/api/server/openapi.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2617,6 +2617,9 @@ paths:
26172617
Downloads a complete backup of the Ella Core database as a gzipped tar
26182618
archive (`.tar.gz`) containing `ella.db` and a `manifest.json`
26192619
describing the backup format version.
2620+
2621+
The archive contains sensitive secrets. Store and transfer it
2622+
encrypted, and treat it as an admin credential.
26202623
responses:
26212624
"200":
26222625
description: Database backup archive.

ui/src/pages/BackupRestore.tsx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,11 @@ const BackupRestore = () => {
220220
your system if needed.
221221
</Typography>
222222

223+
<Alert severity="warning">
224+
This archive contains sensitive secrets. Store and transfer it
225+
encrypted, and treat it as you would an admin credential.
226+
</Alert>
227+
223228
<Box sx={{ flexGrow: 1 }} />
224229
<Box sx={{ display: "flex", justifyContent: "center" }}>
225230
<Button

0 commit comments

Comments
 (0)