Data directory contains:
document.db - database
+ document.db - database
config.ini - instance level settings like port on which the
+ config.ini - instance level settings like port on which the
Trilium application runsbackup - contains automatically backup of
+ backup - contains automatically backup of
documentslog - contains application log fileslog - contains application log filesEasy way how to find out which data directory Trilium uses is to look @@ -18,30 +18,42 @@
Data directory is normally named trilium-data and it is stored
in:
/home/[user]/.local/share for LinuxC:\Users\[user]\AppData\Roaming for Windows Vista and up/Users/[user]/Library/Application Support for Mac OS/home/[user]/.local/share for LinuxC:\Users\[user]\AppData\Roaming for Windows Vista and up/Users/[user]/Library/Application Support for Mac OSIf you want to back up your Trilium data, just backup this single directory - it contains everything you need.
If you want to use some other location for the data directory than the - default one, you may change it via TRILIUM_DATA_DIR environment variable - to some other location:
+ default one, you may change it viaTRILIUM_DATA_DIR environment
+ variable to some other location:
+TRILIUM_DATA_DIR.export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-dataYou need to create a .plist file under ~/Library/LaunchAgents to
load it properly each login.
To load it manually, you need to use launchctl setenv TRILIUM_DATA_DIR <yourpath>
Here is a pre-defined template, where you just need to add your path to:
-
-
-
-
- Label
+Here is a pre-defined template, where you just need to add your path to:
Label
set.trilium.env
RunAtLoad
@@ -50,76 +62,75 @@
launchctl
setenv
TRILIUM_DATA_DIR
- /Users/YourUserName/Library/Application Support/trilium-data
-
-
-
+ /Users/YourUserName/Library/Application Support/trilium-data An alternative to globally setting environment variable is to run only the Trilium Notes with this environment variable. This then allows for different setup styles like two database instances or "portable" installation.
-To do this in unix based systems simply run trilium like this:
TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data triliumTo do this in Unix-based systems simply run trilium like this:
TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data triliumYou can then save the above command as a shell script on your path for convenience.
Apart from the data directory, some of the subdirectories of it can be moved elsewhere by changing an environment variable:
-| 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. | -
| 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. | +
+There are multiple types of documentation for Trilium:
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing F1.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index 86ddd9589..c0be59116 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -25,56 +25,35 @@
{
"type": "relation",
"name": "internalLink",
- "value": "BFs8mudNFgCS",
+ "value": "gh7bpGYxajRS",
"isInheritable": false,
"position": 20
},
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "BFs8mudNFgCS",
+ "isInheritable": false,
+ "position": 30
+ },
{
"type": "relation",
"name": "internalLink",
"value": "GTwFsgaA0lCt",
"isInheritable": false,
- "position": 30
- },
- {
- "type": "label",
- "name": "shareAlias",
- "value": "user-guide",
- "isInheritable": false,
- "position": 10
- },
- {
- "type": "label",
- "name": "label:shareAlias",
- "value": "promoted,alias=Slug,single,text",
- "isInheritable": true,
- "position": 20
- },
- {
- "type": "label",
- "name": "iconClass",
- "value": "bx bx-help-circle",
- "isInheritable": false,
- "position": 30
+ "position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "poXkQfguuA0U",
"isInheritable": false,
- "position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "WOcw2SLH6tbX",
- "isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
- "value": "gh7bpGYxajRS",
+ "value": "WOcw2SLH6tbX",
"isInheritable": false,
"position": 60
},
@@ -98,6 +77,27 @@
"value": "9qPsTWBorUhQ",
"isInheritable": false,
"position": 90
+ },
+ {
+ "type": "label",
+ "name": "shareAlias",
+ "value": "user-guide",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "label",
+ "name": "label:shareAlias",
+ "value": "promoted,alias=Slug,single,text",
+ "isInheritable": true,
+ "position": 20
+ },
+ {
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-help-circle",
+ "isInheritable": false,
+ "position": 30
}
],
"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 c2f3650c5..3d66bafe9 100644
--- a/docs/User Guide/User Guide/Installation & Setup/Data directory.md
+++ b/docs/User Guide/User Guide/Installation & Setup/Data directory.md
@@ -26,7 +26,17 @@ If you want to back up your Trilium data, just backup this single directory - it
### Changing the location of data directory
-If you want to use some other location for the data directory than the default one, you may change it via TRILIUM\_DATA\_DIR environment variable to some other location:
+If you want to use some other location for the data directory than the default one, you may change it via `TRILIUM_DATA_DIR` environment variable to some other location:
+
+### Windows
+
+1. Press the Windows key on your keyboard.
+2. Search and select “Edit the system variables”.
+3. Press the “Environment Variables…” button in the bottom-right of the newly opened screen.
+4. On the top section ("User variables for \[user\]"), press the “New…” button.
+5. In the _Variable name_ field insert `TRILIUM_DATA_DIR`.
+6. Press the _Browse Directory…_ button and select the new directory where to store the database.
+7. Close all the windows by pressing the _OK_ button for each of them.
#### Linux
@@ -43,11 +53,6 @@ To load it manually, you need to use `launchctl setenv TRILIUM_DATA_DIR