The permanent directory has the following sub-directories:
| Sub-directory | Description |
|---|
| store | Contains data stores. It has two sub-directories:- store/file: stores attachments and deleted Pages.
- By default, attachments are saved on the filesystem. If configured, attachments can be stored in the database sub-directory of the permanent directory. Attachment metadata (e.g. creator, date, etc) is saved in the database.
- XWiki 17.10.0+ Attachments can be also stored in S3. In this case, the directory structure is preserved, meaning the relative paths under the permanent directory correspond to keys in the configured S3 bucket.
- store/solr: Contains Solr configuration and data that cannot be reindexed from another data source (cache data is stored separately in the cache directory.
|
| extension | Installed extensions and their metadata about where they are installed. |
| cache | Contains cache files.- These files and subdirectories can be safely removed; XWiki regenerates them when needed. Regeneration can take significant time, especially for large instances.
- Examples of cached data:
- Solr search indexes.
- Descriptors of core extensions. If removed, XWiki resolves them again at startup. Most descriptors are already embedded in the JARs packaged within the WAR, so only a limited number may need to be downloaded again. Removing them can help clean up descriptors from previous XWiki versions.
- FOP font cache.
|
| mails | Stores email messages handled by the Mail Sender API. Email messages are serialized in this directory before being sent. This ensures that messages are not lost if XWiki stops or crashes. After a successful send, the corresponding file is removed. Thus this directory will contain mails that failed to be sent. |
| logs | (Only available for XWiki Standalone (Demo) Distribution which has Jetty configured to generate its logs in this directory). Contains XWiki logs. |
| jobs/status | Stores logs and statuses of background jobs executed by XWiki (e.g., when deleting a Page, a job is used). The directory structure follows the job ID.- Starting with XWiki 17.2.0+, 16.10.6+ the path is prefixed with a store version (currently 3) to account for differences in how job IDs are mapped to file names across versions.
- Most entries are used only to track job execution and are generally safe to remove. However, some jobs may rely on their stored status.
- Examples of standard job directories (extensions may add more):
- jobs/status/3/distribution: Stores decisions made in the Distribution Wizard (typically during installation or upgrade). It is recommended to keep this data. If removed, the worst case is that the Distribution Wizard may appear again on the next startup (e.g., if a DW step is triggered), and some steps may need to be canceled again.
- jobs/status/3/extension: Stores logs of extension install and uninstall operations. Safe to remove; only the operation history is lost.
- jobs/status/3/refactoring: Stores logs of refactoring operations. Safe to remove; only the operation history is lost.
- jobs/status/3/solr/indexer: Stores logs of Solr indexing operations. Safe to remove; only the operation history is lost.
- jobs/status/3/wikicreation: Stores logs of wiki creation operations. Safe to remove; only the operation history is lost.
|
| database | (Only available for XWiki Standalone (Demo) Distribution). Contains the HSQLDB database data. |
| observation | The Observation Module Remote uses this directory to store the unique identifier of the instance in a cluster. |
| configuration.properties | Contains configuration generated by XWiki itself (for example, the validation and encryption keys used for cookies when not provided in xwiki.cfg) |
