Skip to content

docs: document the /romm/sync mount and the new download cache location - #174

Merged
gantoine merged 2 commits into
mainfrom
docs/sync-mount-and-cache-location
Oct 8, 2026
Merged

gantoine merged 2 commits into
mainfrom
docs/sync-mount-and-cache-location

Conversation

@gantoine

@gantoine gantoine commented Oct 8, 2026

Copy link
Copy Markdown
Member

Follows rommapp/romm#5189. Merge after it lands.

  • Library conversion: the conversion cache is now at /tmp/romm/cache/converts inside the container, or $ROMM_TMP_PATH/cache/converts when that's set. It's cleared when the container is recreated. Points small-Docker-disk users at ROMM_TMP_PATH, and says library conversion doesn't use the cache.
  • Quick start: adds a commented-out /path/to/sync:/romm/sync mount and a row in the "values to edit" table, for anyone enabling the sync folder watcher or push/pull sync.
  • Backup & Restore: adds /romm/sync (SSH keys, known_hosts, incoming device files) to the "what to back up" table.
  • Unraid: notes that a 99:100 container can only write to the paths you map, so the sync features need a /romm/sync mapping, and ROMM_TMP_PATH keeps the caches out of docker.img.

The env-vars table picks up the updated ROMM_TMP_PATH description the next time sources.toml is bumped and gen_env_vars is re-run.

AI assistance: written with Claude Code (Claude Opus 5.5), reviewed by me.

🤖 Generated with Claude Code

gantoine and others added 2 commits October 8, 2026 12:15
Follows rommapp/romm#5189, which moves the zip and conversion caches to
/tmp/romm/cache (or $ROMM_TMP_PATH/cache) and makes an unwritable
/romm/sync disable the sync folder watcher instead of stopping startup.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@gantoine
gantoine merged commit 56941c6 into main Oct 8, 2026
4 checks passed
@gantoine
gantoine deleted the docs/sync-mount-and-cache-location branch October 8, 2026 17:03
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.

1 participant