stashapp/Stash-Docs
1
0
Fork 0
mirror of https://github.com/stashapp/Stash-Docs.git synced 2026-04-12 23:37:00 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update backup and restore database guide to include blobs

Browse Source
This commit is contained in:
DogmaDragon
2026-02-13 18:40:19 +02:00
parent 1313825e47
commit 117f91396a
1 changed files with 35 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/guides/backup-and-restore-database.md
View File

@@ -4,44 +4,55 @@ title: Backup and restore database
## Backup
Always use the UI to create a backup of the database. As with all live databases **DO NOT** copy manually the database file as a means of backup.
Stash uses an sqlite database with `WAL` mode enabled. This practically means that along with the main db file `stash-go.sqlite` there can be a `-shm` and a `-wal` file present ([more info](https://sqlite.org/wal.html){:target="_blank"}). Even stopping Stash might leave some of these index files present so again **DO NOT** manually copy the database file.
To back up your database, always use the Stash UI. Do not manually copy the database file while Stash is running.
Stash uses an SQLite database in `WAL` (Write-Ahead Logging) mode. In addition to the main `stash-go.sqlite` file, there may also be `-shm` and `-wal` files present. These files can remain even after stopping Stash. For this reason, you should never manually copy the database files as a backup method.
??? info "WAL mode"
Learn more about `WAL` mode in SQLite [here](https://sqlite.org/wal.html){:target="_blank"}.
The **Backup** or **Download Backup** tasks are the proper way to create a backup file.
1. Go to :fontawesome-solid-gear: **Settings** > **System**.
1. Under Application Paths heading scroll down to **Backup Directory Path**.
1. Set directory to store your backups.
1. Go to :fontawesome-solid-gear: **Settings** > **Tasks**.
1. Under Backup heading you will find 2 tasks.
1. Select either **Backup** or **Download Backup** task.
2. Under the Application Paths heading, scroll down to **Backup directory path**.
3. Set the directory to store your backups.
4. Go to :fontawesome-solid-gear: **Settings** > **Tasks**.
5. Under the Backup heading, you will find two tasks.
6. Select either the **Backup** or **Download backup** task.
### Backing up blobs
If you have binary data stored outside the database file, you need to back it up independently. This can be done by copying the relevant folder.
1. Go to :fontawesome-solid-gear: **Settings** > **System**.
2. Under the Database heading, look for **Binary data storage type**.
3. If it's set to `Filesystem`, look below for **Binary data path**. This is the directory where your blobs are stored.
4. Use your file browser to copy the entire directory to your backup location.
## Restore
Assuming you have properly created a backup file you can use it to restore your database if needed.
Assuming you have properly created a backup file, you can use it to restore your database if needed.
!!! info
The restore procedure uses the default `stash-go.sqlite` filename, if you changed that when configuring Stash adjust accordingly.
!!! info
The restore procedure uses the default `stash-go.sqlite` filename. If you changed that when configuring Stash, adjust accordingly.
The following steps are recommended when restoring a database file:
1. Go to :fontawesome-solid-gear: **Settings** > **System**, scroll down to Database heading and check your **Database Path** location.
1. Create a backup of the current database. (optional)
1. Stop Stash.
1. In your file browser, go to the location of your database path.
1. Move or delete the `stash-go.sqlite` database file (along with the `-shm` `-wal` `.journal` files if present).
1. Copy the backup file that you want to restore to `stash-go.sqlite`.
1. Make sure that you now have a `stash-go.sqlite` file and that no `-shm` `-wal` `.journal` files are present.
1. Start Stash.
1. Go to :fontawesome-solid-gear: **Settings** > **System**, scroll down to the Database heading, and check your **Database path** location.
1. Check what your **Binary data storage type** is set to.
2. If it's set to `Filesystem`, look below for **Binary data path** and move your backed up blobs to that location. If set to `Database`, skip this step.
3. Create a backup of the current database (optional).
4. Stop Stash.
5. In your file browser, go to the location of your database path.
6. Move or delete the `stash-go.sqlite` database file (along with the `-shm`, `-wal`, and `.journal` files if present).
7. Copy the backup file that you want to restore to `stash-go.sqlite`.
8. Make sure that you now have a `stash-go.sqlite` file and that no `-shm`, `-wal`, or `.journal` files are present.
9. Start Stash.
You should now have Stash running with a working and restored database.
## Advanced troubleshooting
If you get a database malformed message during upgrade or backup that probably means that the database is already corrupt. One way to get past that is to do a full export and check the error log. If there are not a lot of errors you can then try to do a full import and get a working db with minimal losses. As the full import is destructive proceed with caution.
For cases like this it is better to ask for [support](/#support).
If you get a "database malformed" message during upgrade or backup, that probably means the database is already corrupt. One way to get past this is to do a full export and check the error log. If there are not a lot of errors, you can then try to do a full import and get a working database with minimal losses. As the full import is destructive, proceed with caution.
For cases like this, it is better to ask for [support](/#support).