wrolpi-help/docs/system/special-directories.md
Roland 3a4496c60f
Repos: document the git Repos module
Adding a repo, Full history and Snapshot modes, branches, updates and
failures, browsing, README search under the Other tab, tagging,
deleting, the Repos Directory setting, and repos.yaml.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-06 12:10:01 -06:00

2.6 KiB

Special System Directories

Path Purpose
/media/wrolpi/ The Media Directory.
/media/wrolpi/config/ The configuration files of the WROLPi.
/media/wrolpi/tags/ The Tags Directory contains links to files that have been tagged.
/media/wrolpi/repos/ The Repos Directory contains your git repos.
/opt/wrolpi-blobs/ Contains files necessary to repair a WROLPi.
/opt/wrolpi-help/ These help files.
/opt/wrolpi/ The source code of WROLPi.

Media Directory

/media/wrolpi/

The media directory is a ubiquitous part of WROLPi. It is expected that an external drive will be mounted here. All files that are downloaded by WROLPi will be saved within this directory.

The normal media directory is /media/wrolpi

WROLPi Config

/media/wrolpi/config/

This directory contains the configuration files of the WROLPi and the SQLite database (wrolpi.db). Config files are considered the "source of truth" and their contents will alter the behavior of the WROLPi. See How Configs Work and Databases.

Tags Directory

/media/wrolpi/tags

This directory contains links to tagged files. It is automatically managed by WROLPi as you add or remove tags from files. See Tags.

Warning! Do not store files in this directory, they will be automatically deleted.

Repos Directory

/media/wrolpi/repos

This directory contains the git repos of the Repos module. Its files are never indexed, so they do not appear in file search.

Warning! WROLPi keeps each repo identical to its source; changes you make to a repo's files are discarded by the next update.

WROLPi Blobs

/opt/wrolpi-blobs/

This directory contains files necessary to repair a WROLPi (for example map fonts and other offline assets). It is best to leave this directory as-is.

WROLPi Help

/opt/wrolpi-help/

This help file you are reading is contained in this directory.

WROLPi Source Directory

/opt/wrolpi/

This directory contains the source code of the WROLPi API, app, etc.