Mirrors/mealie
1
0
Fork 0
mirror of https://github.com/mealie-recipes/mealie.git synced 2026-02-26 01:33:12 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add additional information and tips to Backup & Restore Usage Documentation Page & Shopping List (#4843)

Browse Source 
Co-authored-by: boc-the-git <3479092+boc-the-git@users.noreply.github.com>
Co-authored-by: Kuchenpirat <24235032+Kuchenpirat@users.noreply.github.com>
This commit is contained in:
Chip
2025-02-25 07:50:44 -05:00
committed by GitHub
parent c01593e918
commit a2c6b3f69b
2 changed files with 42 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/docs/documentation/getting-started/usage/backups-and-restoring.md
View File

@@ -1,17 +1,24 @@
# Backups and Restoring
# Backups and Restores
Mealie provides an integrated mechanics for doing full installation backups of the database. Navigate to `/admin/backups` to
Mealie provides an integrated mechanic for doing full installation backups of the database.
Navigate to Settings > Backups or manually by adding `/admin/backups` to your instance URL.
From this page, you will be able to:
- See a list of available backups
- Perform a backups
- Restore a backup
- Create a backup
- Upload a backup
- Delete a backup (Confirmation Required)
- Download a backup
- Perform a restore
!!! tip
If you're using Mealie with SQLite all your data is stored in the /app/data/ folder in the container. You can easily perform entire site backups by stopping the container, and backing up this folder with your chosen tool. This is the **best** way to backup your data.
## Restoring from a Backup
To restore from a backup it needs to be uploaded to your instance, this can be done through the web portal. On the lower left hand corner of the backups data table you'll see an upload button. Click this button and select the backup file you want to upload and it will be available to import shortly.
To restore from a backup it needs to be uploaded to your instance which can be done through the web portal. On the top left of the page you'll see an upload button. Click this button and select the backup file you want to upload and it will be available to import shortly. You can alternatively use one of the backups you see on the screen, if one exists.
Before importing it's critical that you understand the following:
@@ -19,6 +26,9 @@ Before importing it's critical that you understand the following:
- This action cannot be undone
- If this action is successful you will be logged out and you will need to log back in to complete the restore
!!! tip
If for some reason the restore does not succeed, you can review the logs of what the issue may be, download the backup .ZIP and edit the contents of database.json to potentially resolve the issue. For example, if you receive an error restoring 'shopping-list' you can edit out the contents of that list while allowing other sections to restore. If you would like any assistance on this, reach out over Discord.
!!! warning
Prior to beta-v5 using a mis-matched version of the database backup will result in an error that will prevent you from using the instance of Mealie requiring you to remove all data and reinstall. Post beta-v5 performing a mismatched restore will throw an error and alert the user of the issue.