Note Types
+ +
+
+ T
+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 runs
- backup- contains automatically backup of +backup- contains automatically backup of documents
- log- contains application log files
+ log- contains application log files
Location of the data directory
Easy 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/sharefor Linux
- C:\Users\[user]\AppData\Roamingfor Windows Vista and up
- /Users/[user]/Library/Application Supportfor Mac OS
- - user's home is a fallback if some of the paths above don't exist -
- user's home is also a default setup for [[docker|Docker server installation]] +
/home/[user]/.local/sharefor Linux
+ C:\Users\[user]\AppData\Roamingfor Windows Vista and up
+ /Users/[user]/Library/Application Supportfor Mac OS
+ - user's home is a fallback if some of the paths above don't exist +
- user's home is also a default setup for [[docker|Docker server installation]]
If you want to back up your Trilium data, just backup this single directory - it contains everything you need.
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:
+ default one, you may change it viaTRILIUM_DATA_DIR environment
+ variable to some other location:
+Windows
+-
+
- Press the Windows key on your keyboard. +
- Search and select “Edit the system variables”. +
- Press the “Environment Variables…” button in the bottom-right of the newly + opened screen. +
- On the top section ("User variables for [user]"), press the “New…” button. +
- In the Variable name field insert
TRILIUM_DATA_DIR.
+ - Press the Browse Directory… button and select the new directory + where to store the database. +
- Close all the windows by pressing the OK button for each of them. +
Linux
export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-dataMac OS X
You 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 Create a script to run with specific data directory
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.
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 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
diff --git a/docs/Developer Guide/!!!meta.json b/docs/Developer Guide/!!!meta.json
index 397bdcab4..63e4d0cc4 100644
--- a/docs/Developer Guide/!!!meta.json
+++ b/docs/Developer Guide/!!!meta.json
@@ -15,6 +15,20 @@
"type": "text",
"mime": "text/html",
"attributes": [
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "T2W7WCZrYZBU",
+ "isInheritable": false,
+ "position": 10
+ },
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "cxfTSHIUQtt2",
+ "isInheritable": false,
+ "position": 20
+ },
{
"type": "label",
"name": "label:shareAlias",
@@ -35,20 +49,6 @@
"value": "developer-guide",
"isInheritable": false,
"position": 30
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "T2W7WCZrYZBU",
- "isInheritable": false,
- "position": 40
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "cxfTSHIUQtt2",
- "isInheritable": false,
- "position": 50
}
],
"format": "markdown",
@@ -817,7 +817,7 @@
"name": "internalLink",
"value": "Jg7clqogFOyD",
"isInheritable": false,
- "position": 20
+ "position": 10
},
{
"type": "label",
diff --git a/docs/Developer Guide/Developer Guide/Architecture/Security.md b/docs/Developer Guide/Developer Guide/Architecture/Security.md
index 61fdc7377..f1ef4da77 100644
--- a/docs/Developer Guide/Developer Guide/Architecture/Security.md
+++ b/docs/Developer Guide/Developer Guide/Architecture/Security.md
@@ -383,7 +383,7 @@ for (const blob of orphanedBlobs) {
**Process:**
-```sh
+```
# Check for vulnerabilities
npm audit
@@ -424,7 +424,7 @@ npm audit fix --force
**pnpm Patches:**
-```sh
+```
# Create patch
pnpm patch @ckeditor/ckeditor5
diff --git a/docs/Developer Guide/Developer Guide/Concepts/Synchronisation.md b/docs/Developer Guide/Developer Guide/Concepts/Synchronisation.md
index f97bd3c4e..45a520cb6 100644
--- a/docs/Developer Guide/Developer Guide/Concepts/Synchronisation.md
+++ b/docs/Developer Guide/Developer Guide/Concepts/Synchronisation.md
@@ -9,7 +9,7 @@ Trilium implements a **bidirectional synchronization system** that allows users
## Sync Architecture
-```mermaid
+```
graph TB
Desktop1[Desktop 1| 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. | +
Client] Desktop2[Desktop 2
Client] diff --git a/docs/Developer Guide/Developer Guide/Documentation.md b/docs/Developer Guide/Developer Guide/Documentation.md index 4da87601a..c11d3164c 100644 --- a/docs/Developer Guide/Developer Guide/Documentation.md +++ b/docs/Developer Guide/Developer Guide/Documentation.md @@ -1,5 +1,5 @@ # Documentation -There are multiple types of documentation for Trilium:
+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 - Canvas diff --git a/apps/edit-docs/demo/root/Miscellaneous/Day Note Template.html b/apps/edit-docs/demo/root/Miscellaneous/Day Note Template.html index 8f2333bf0..a33b14490 100644 --- a/apps/edit-docs/demo/root/Miscellaneous/Day Note Template.html +++ b/apps/edit-docs/demo/root/Miscellaneous/Day Note Template.html @@ -14,6 +14,7 @@
- […]
- First Item @@ -56,7 +50,6 @@
- Item @@ -67,7 +60,6 @@
☑️ Tasks
+
+
Welcome to Trilium Notes! -
This is a "demo" document packaged with Trilium to showcase some of its features and also give you some ideas on how you might structure your notes. @@ -26,22 +25,17 @@ you wish.
If you need any help, visit triliumnotes.org or our GitHub repository -
Cleanup
-Once you're finished with experimenting and want to cleanup these pages, you can simply delete them all.
Formatting
-Trilium supports classic formatting like italic, bold, bold and italic. You can add links pointing to external pages or Formatting examples.
Lists
-Ordered: -
Unordered: -
Block quotes
-Whereof one cannot speak, thereof one must be silent”
– Ludwig Wittgenstein
@@ -75,9 +67,9 @@
See also other examples like tables, checkbox lists, highlighting, + href="Trilium%20Demo/Formatting%20examples/Checkbox%20lists.html">checkbox lists, highlighting, code blocksand code blocksand math examples.
+ href="Trilium%20Demo/Formatting%20examples/Math.html">math examples.