From 99f43e2280b3425d915b5bf1c0c68065a52bd125 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Thu, 30 Oct 2025 12:02:32 +0200 Subject: [PATCH] docs(user): improve fine-grained directory path documentation --- .../Installation & Setup/Data directory.html | 109 +++++++++++++----- docs/User Guide/!!!meta.json | 21 ++++ .../Installation & Setup/Data directory.md | 21 ++-- 3 files changed, 114 insertions(+), 37 deletions(-) diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html index 60589b51e..3b6929581 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html @@ -1,14 +1,14 @@

Data directory contains:

-

Location

+

Location of the data directory

Easy way how to find out which data directory Trilium uses is to look at the "About Trilium Notes" dialog (from "Menu" in upper left corner):

@@ -18,11 +18,14 @@

Data directory is normally named trilium-data and it is stored in:

If you want to back up your Trilium data, just backup this single directory - it contains everything you need.

@@ -62,20 +65,72 @@

To do this in unix based systems simply run trilium like this:

TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data trilium

You can then save the above command as a shell script on your path for convenience.

-

Fine-grained directory/path location

-

It's possible to configure e.g. backup and log directories separately, - with following environment variables:

- -

If these are not set, default paths within the data directory will be - used.

\ No newline at end of file +

Fine-grained directory/path location

+

Apart from the data directory, some of the subdirectories of it can be + moved elsewhere by changing an environment variable:

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Environment variableDefault valueDescription
TRILIUM_DOCUMENT_PATH + ${TRILIUM_DATA_DIR}/document.db + Path to the Database (storing + all notes and metadata).
TRILIUM_BACKUP_DIR + ${TRILIUM_DATA_DIR}/backup + Directory where automated Backup databases + are stored.
TRILIUM_LOG_DIR + ${TRILIUM_DATA_DIR}/log + Directory where daily Backend (server) logs are + stored.
TRILIUM_TMP_DIR + ${TRILIUM_DATA_DIR}/tmp + Directory where temporary files are stored (for example when opening in + an external app).
TRILIUM_ANONYMIZED_DB_DIR + ${TRILIUM_DATA_DIR}/anonymized-db + Directory where a Anonymized Database is + stored.
TRILIUM_CONFIG_INI_PATH + ${TRILIUM_DATA_DIR}/config.ini + Path to Configuration (config.ini or environment variables) file.
+
\ No newline at end of file diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index 21eb6a173..413988f26 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -1534,6 +1534,27 @@ "value": "bx bx-folder-open", "isInheritable": false, "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "bnyigUA2UK7s", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "x59R8J8KV5Bp", + "isInheritable": false, + "position": 60 + }, + { + "type": "relation", + "name": "internalLink", + "value": "Gzjqa934BdH4", + "isInheritable": false, + "position": 70 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide/Installation & Setup/Data directory.md b/docs/User Guide/User Guide/Installation & Setup/Data directory.md index b4677c1c5..c2f3650c5 100644 --- a/docs/User Guide/User Guide/Installation & Setup/Data directory.md +++ b/docs/User Guide/User Guide/Installation & Setup/Data directory.md @@ -6,7 +6,7 @@ Data directory contains: * `backup` - contains automatically [backup](Backup.md) of documents * `log` - contains application log files -## Location +## Location of the data directory Easy way how to find out which data directory Trilium uses is to look at the "About Trilium Notes" dialog (from "Menu" in upper left corner): @@ -75,14 +75,15 @@ TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data trilium You can then save the above command as a shell script on your path for convenience. -### Fine-grained directory/path location +## Fine-grained directory/path location -It's possible to configure e.g. backup and log directories separately, with following environment variables: +Apart from the data directory, some of the subdirectories of it can be moved elsewhere by changing an environment variable: -* `TRILIUM_DOCUMENT_PATH` -* `TRILIUM_BACKUP_DIR` -* `TRILIUM_LOG_DIR` -* `TRILIUM_ANONYMIZED_DB_DIR` -* `TRILIUM_CONFIG_INI_PATH` - -If these are not set, default paths within the data directory will be used. \ No newline at end of file +| Environment variable | Default value | Description | +| --- | --- | --- | +| `TRILIUM_DOCUMENT_PATH` | `${TRILIUM_DATA_DIR}/document.db` | Path to the Database (storing all notes and metadata). | +| `TRILIUM_BACKUP_DIR` | `${TRILIUM_DATA_DIR}/backup` | Directory where automated Backup databases are stored. | +| `TRILIUM_LOG_DIR` | `${TRILIUM_DATA_DIR}/log` | Directory where daily Backend (server) logs are stored. | +| `TRILIUM_TMP_DIR` | `${TRILIUM_DATA_DIR}/tmp` | Directory where temporary files are stored (for example when opening in an external app). | +| `TRILIUM_ANONYMIZED_DB_DIR` | `${TRILIUM_DATA_DIR}/anonymized-db` | Directory where a Anonymized Database is stored. | +| `TRILIUM_CONFIG_INI_PATH` | `${TRILIUM_DATA_DIR}/config.ini` | Path to Configuration (config.ini or environment variables) file. | \ No newline at end of file