missing README edits
This commit is contained in:
parent
6ad6044a76
commit
1beaf406cc
1 changed files with 20 additions and 0 deletions
20
README.md
20
README.md
|
|
@ -224,6 +224,26 @@ Zerobyte allows you to easily restore your data from backups. To restore data, n
|
|||
|
||||

|
||||
|
||||
## 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:
|
||||
|
|
|
|||
Loading…
Reference in a new issue