From 1beaf406ccfbb75f773330fa5a9e2523ace2588b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Tr=C3=A1vn=C3=ADk?= Date: Wed, 17 Dec 2025 17:52:18 +0100 Subject: [PATCH] missing README edits --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index f05ece02..67954474 100644 --- a/README.md +++ b/README.md @@ -224,6 +224,26 @@ Zerobyte allows you to easily restore your data from backups. To restore data, n ![Preview](https://github.com/nicotsx/zerobyte/blob/main/screenshots/restoring.png?raw=true) +## Exporting configuration + +Zerobyte allows you to export your configuration for backup, migration, or documentation purposes. + +To export, click the "Export" button in Settings. A dialog will appear with options to: + +- **Include metadata** - Include IDs, timestamps, and runtime state of entities +- **Secrets handling**: + - **Exclude** - Remove sensitive fields like passwords and API keys + - **Keep encrypted** - Export secrets in encrypted form (requires the same recovery key to decrypt on import) + - **Decrypt** - Export secrets as plaintext (use with caution) +- **Include recovery key** - Include the master encryption key for all repositories +- **Include password hash** - Include the hashed user passwords for seamless migration + +Export requires password verification for security. You must enter your password to confirm your identity before any configuration can be exported. + +Export is downloaded as JSON file that can be used for reference or future import functionality. + +> **Sensitive data handling**: Some sensitive data from earlier versions may not be encrypted in the database. Additionally, nested configuration objects within config fields are exported as-is and not processed separately. Review exported data carefully before sharing, especially when using the "Decrypt" secrets option. + ## Third-Party Software This project includes the following third-party software components: