40 lines
1.5 KiB
Plaintext
40 lines
1.5 KiB
Plaintext
---
|
|
tags:
|
|
- Backup
|
|
- SQLite
|
|
- Management
|
|
- Data
|
|
---
|
|
|
|
# Backup and restore
|
|
|
|
Administrators using SQLite can export and restore the complete Homarr database under
|
|
**Management → Tools → Backup**. MySQL and PostgreSQL installations must use their database-native backup tools.
|
|
|
|
|
|
|
|
## Export
|
|
|
|
The ZIP contains:
|
|
|
|
| File | Contents |
|
|
| --------------- | ----------------------------------------------------------- |
|
|
| `db.sqlite` | Apps, integrations, boards, users, settings, and other data |
|
|
| `metadata.json` | Homarr version, backup timestamp, and encryption metadata |
|
|
|
|
Export requires typing `I understand`. Store the ZIP as sensitive data: it contains the database and the material
|
|
needed to restore encrypted integration credentials.
|
|
|
|
## Restore
|
|
|
|
Select a Homarr backup ZIP. The browser previews entity counts, board names, and required database migrations before
|
|
the archive is uploaded.
|
|
|
|
Restoring replaces the current SQLite database and cannot be undone. After a successful restore, the Next.js process
|
|
restarts and the page reloads when Homarr is ready.
|
|
|
|
A backup can be restored on another Homarr instance. When its `SECRET_ENCRYPTION_KEY` differs, Homarr re-encrypts stored
|
|
integration secrets for the target instance. Version metadata is used to apply compatible migrations.
|
|
|
|
The same restore flow is available during first-run onboarding, before the target database contains user data.
|