Manage shared resources in Docker

This guide explains where Docker stores shared dictionaries and style guide files for self-hosted WProofreader.

Mount a persistent volume to /dictionaries so these resources survive container restarts and replacements.

Directory structure

The Docker image stores shared resources under /dictionaries:

/dictionaries/
├── CustomDictionaries/
│   ├── CustDictConfig.xml
│   └── customDictionary1.txt
├── UserDictionaries/
│   └── user_dictionary_example
└── StyleGuide/
    └── client/
        ├── common/
        │   └── style_guide.csv
        └── en/
            └── example_style_guide.csv

Persist data with a volume mount

Mount a host directory to /dictionaries:

docker run -v <host_directory_path>:/dictionaries <image_name>

This keeps dictionaries and style guide files after the container is recreated or updated.

Resource locations

Organization dictionaries

/dictionaries/CustomDictionaries/
/dictionaries/CustomDictionaries/CustDictConfig.xml

For file structure and management steps, see Organization dictionary: Self-hosted management.

User dictionaries

/dictionaries/UserDictionaries/

For file paths and admin-side management details, see User dictionary: self-hosted management.

Style guide files

/dictionaries/StyleGuide/client/

For file structure and rule management, see Style guide: Self-hosted.