Skip to content

Commit 99f43e2

Browse files
committed
docs(user): improve fine-grained directory path documentation
1 parent bcffa77 commit 99f43e2

File tree

3 files changed

+114
-37
lines changed

3 files changed

+114
-37
lines changed

apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html

Lines changed: 82 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/User Guide/!!!meta.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1534,6 +1534,27 @@
15341534
"value": "bx bx-folder-open",
15351535
"isInheritable": false,
15361536
"position": 40
1537+
},
1538+
{
1539+
"type": "relation",
1540+
"name": "internalLink",
1541+
"value": "bnyigUA2UK7s",
1542+
"isInheritable": false,
1543+
"position": 50
1544+
},
1545+
{
1546+
"type": "relation",
1547+
"name": "internalLink",
1548+
"value": "x59R8J8KV5Bp",
1549+
"isInheritable": false,
1550+
"position": 60
1551+
},
1552+
{
1553+
"type": "relation",
1554+
"name": "internalLink",
1555+
"value": "Gzjqa934BdH4",
1556+
"isInheritable": false,
1557+
"position": 70
15371558
}
15381559
],
15391560
"format": "markdown",

docs/User Guide/User Guide/Installation & Setup/Data directory.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Data directory contains:
66
* `backup` - contains automatically [backup](Backup.md) of documents
77
* `log` - contains application log files
88

9-
## Location
9+
## Location of the data directory
1010

1111
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):
1212

@@ -75,14 +75,15 @@ TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data trilium
7575

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

78-
### Fine-grained directory/path location
78+
## Fine-grained directory/path location
7979

80-
It's possible to configure e.g. backup and log directories separately, with following environment variables:
80+
Apart from the data directory, some of the subdirectories of it can be moved elsewhere by changing an environment variable:
8181

82-
* `TRILIUM_DOCUMENT_PATH`
83-
* `TRILIUM_BACKUP_DIR`
84-
* `TRILIUM_LOG_DIR`
85-
* `TRILIUM_ANONYMIZED_DB_DIR`
86-
* `TRILIUM_CONFIG_INI_PATH`
87-
88-
If these are not set, default paths within the data directory will be used.
82+
| Environment variable | Default value | Description |
83+
| --- | --- | --- |
84+
| `TRILIUM_DOCUMENT_PATH` | `${TRILIUM_DATA_DIR}/document.db` | Path to the <a class="reference-link" href="../Advanced%20Usage/Database.md">Database</a> (storing all notes and metadata). |
85+
| `TRILIUM_BACKUP_DIR` | `${TRILIUM_DATA_DIR}/backup` | Directory where automated <a class="reference-link" href="Backup.md">Backup</a> databases are stored. |
86+
| `TRILIUM_LOG_DIR` | `${TRILIUM_DATA_DIR}/log` | Directory where daily <a class="reference-link" href="../Troubleshooting/Error%20logs/Backend%20(server)%20logs.md">Backend (server) logs</a> are stored. |
87+
| `TRILIUM_TMP_DIR` | `${TRILIUM_DATA_DIR}/tmp` | Directory where temporary files are stored (for example when opening in an external app). |
88+
| `TRILIUM_ANONYMIZED_DB_DIR` | `${TRILIUM_DATA_DIR}/anonymized-db` | Directory where a <a class="reference-link" href="../Troubleshooting/Anonymized%20Database.md">Anonymized Database</a> is stored. |
89+
| `TRILIUM_CONFIG_INI_PATH` | `${TRILIUM_DATA_DIR}/config.ini` | Path to <a class="reference-link" href="../Advanced%20Usage/Configuration%20(config.ini%20or%20e.md">Configuration (config.ini or environment variables)</a> file. |

0 commit comments

Comments
 (0)