Skip to content

docs: backups page says what cache/ is, and gains a Restoring section - #1379

Open
spelingbee wants to merge 1 commit into
open-webui:mainfrom
spelingbee:docs-backups-cache-and-restoring
Open

docs: backups page says what cache/ is, and gains a Restoring section#1379
spelingbee wants to merge 1 commit into
open-webui:mainfrom
spelingbee:docs-backups-cache-and-restoring

Conversation

@spelingbee

Copy link
Copy Markdown

Summary

Two additions to the backups page. The files table now says what cache/ is (downloaded embedding and speech models, re-downloaded on demand, safe to exclude, and why two of the three example scripts exclude it: on a fresh instance it was 1.1 GB against about a megabyte of user data, and it contains symlinks). And a short Restoring section, since the page covers taking a backup and stops there: stop the stack, put the data directory back, start it, and make sure webui.db-wal / webui.db-shm travel with webui.db if files were copied individually.

Related issue or discussion

#1378

Checklist

  • I have reviewed the relevant documentation and matched the existing style.
  • This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility.
  • I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories.

Notes for reviewers

Measured on v0.11.1 with the default SQLite setup, one account and one chat: du of the data directory was 1.1G, of which cache/ was 1.1G, webui.db 632K, webui.db-wal 160K, vector_db 184K. The restore sequence was tested by restoring the directory into a fresh stack, with and without cache/.

Closes #1378.

## Summary

Two additions to the backups page. The files table now says what `cache/` is (downloaded embedding and speech models, re-downloaded on demand, safe to exclude, and why two of the three example scripts exclude it: on a fresh instance it was 1.1 GB against about a megabyte of user data, and it contains symlinks). And a short Restoring section, since the page covers taking a backup and stops there: stop the stack, put the data directory back, start it, and make sure `webui.db-wal` / `webui.db-shm` travel with `webui.db` if files were copied individually.

## Related issue or discussion

open-webui#1378

## Checklist

- [x] I have reviewed the relevant documentation and matched the existing style.
- [x] This PR meets Open WebUI's contribution standards: it is accurate, relevant to users, narrowly scoped, maintainable, and not promotional content, advertising, lead generation, SEO placement, or a request to list a product, service, provider, integration, gateway, tool, or company primarily for visibility.
- [x] I understand that PRs that do not meet these standards may be closed without review and will not be merged. Repeated, low-quality, off-topic, promotional, or intentionally misleading submissions may result in the contributor being blocked from future participation in Open WebUI repositories.

## Notes for reviewers

Measured on v0.11.1 with the default SQLite setup, one account and one chat: `du` of the data directory was 1.1G, of which `cache/` was 1.1G, `webui.db` 632K, `webui.db-wal` 160K, `vector_db` 184K. The restore sequence was tested by restoring the directory into a fresh stack, with and without `cache/`.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0193orVXP78niTTs6AzLThHK
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: the backups page lists cache/ as data to back up - on a fresh instance it is 99.9% of the backup

2 participants