Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-31 02:16:05 +01:00
Code Issues Packages Projects Releases Activity

chore(docs): fix quick search documentation not in meta

Browse Source
This commit is contained in:
Elian Doran
2025-08-26 19:44:01 +03:00
parent 72e2f6757e
commit 5237348975
15 changed files with 335 additions and 209 deletions
Download Patch File Download Diff File Expand all files Collapse all files

139
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.html generated vendored
View File

@@ -1,24 +1,29 @@
<p>Trilium supports configuration via a file named <code>config.ini</code> and environment variables. This document provides a comprehensive reference for all configuration options.</p> <p>Trilium supports configuration via a file named <code>config.ini</code> and
environment variables. This document provides a comprehensive reference
for all configuration options.</p>
<h2>Configuration Precedence</h2> <h2>Configuration Precedence</h2>
<p>Configuration values are loaded in the following order of precedence (highest to lowest):</p> <p>Configuration values are loaded in the following order of precedence (highest
to lowest):</p>
<ol> <ol>
<li><strong>Environment variables</strong> (checked first)</li> <li><strong>Environment variables</strong> (checked first)</li>
<li><strong>config.ini file values</strong></li> <li><strong>config.ini file values</strong>
<li><strong>Default values</strong></li> </li>
<li><strong>Default values</strong>
</li>
</ol> </ol>
<h2>Environment Variable Patterns</h2> <h2>Environment Variable Patterns</h2>
<p>Trilium supports multiple environment variable patterns for flexibility. The primary pattern is: <code>TRILIUM_[SECTION]_[KEY]</code></p> <p>Trilium supports multiple environment variable patterns for flexibility.
The primary pattern is: <code>TRILIUM_[SECTION]_[KEY]</code>
</p>
<p>Where:</p> <p>Where:</p>
<ul> <ul>
<li><code>SECTION</code> is the INI section name in UPPERCASE</li> <li><code>SECTION</code> is the INI section name in UPPERCASE</li>
<li><code>KEY</code> is the camelCase configuration key converted to UPPERCASE (e.g., <code>instanceName</code> → <code>INSTANCENAME</code>)</li> <li><code>KEY</code> is the camelCase configuration key converted to UPPERCASE
(e.g., <code>instanceName</code> → <code>INSTANCENAME</code>)</li>
</ul> </ul>
<p>Additionally, shorter aliases are available for common configurations (see Alternative Variables section below).</p> <p>Additionally, shorter aliases are available for common configurations
(see Alternative Variables section below).</p>
<h2>Environment Variable Reference</h2> <h2>Environment Variable Reference</h2>
<h3>General Section</h3> <h3>General Section</h3>
<table> <table>
<thead> <thead>
@@ -31,31 +36,36 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><code>TRILIUM_GENERAL_INSTANCENAME</code></td> <td><code>TRILIUM_GENERAL_INSTANCENAME</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>Instance name for API identification</td> <td>Instance name for API identification</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_GENERAL_NOAUTHENTICATION</code></td> <td><code>TRILIUM_GENERAL_NOAUTHENTICATION</code>
</td>
<td>boolean</td> <td>boolean</td>
<td>false</td> <td>false</td>
<td>Disable authentication (server only)</td> <td>Disable authentication (server only)</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_GENERAL_NOBACKUP</code></td> <td><code>TRILIUM_GENERAL_NOBACKUP</code>
</td>
<td>boolean</td> <td>boolean</td>
<td>false</td> <td>false</td>
<td>Disable automatic backups</td> <td>Disable automatic backups</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_GENERAL_NODESKTOPICON</code></td> <td><code>TRILIUM_GENERAL_NODESKTOPICON</code>
</td>
<td>boolean</td> <td>boolean</td>
<td>false</td> <td>false</td>
<td>Disable desktop icon creation</td> <td>Disable desktop icon creation</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_GENERAL_READONLY</code></td> <td><code>TRILIUM_GENERAL_READONLY</code>
</td>
<td>boolean</td> <td>boolean</td>
<td>false</td> <td>false</td>
<td>Enable read-only mode</td> <td>Enable read-only mode</td>
@@ -75,55 +85,64 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><code>TRILIUM_NETWORK_HOST</code></td> <td><code>TRILIUM_NETWORK_HOST</code>
</td>
<td>string</td> <td>string</td>
<td>"0.0.0.0"</td> <td>"0.0.0.0"</td>
<td>Server host binding</td> <td>Server host binding</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_NETWORK_PORT</code></td> <td><code>TRILIUM_NETWORK_PORT</code>
</td>
<td>string</td> <td>string</td>
<td>"3000"</td> <td>"3000"</td>
<td>Server port</td> <td>Server port</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_NETWORK_HTTPS</code></td> <td><code>TRILIUM_NETWORK_HTTPS</code>
</td>
<td>boolean</td> <td>boolean</td>
<td>false</td> <td>false</td>
<td>Enable HTTPS</td> <td>Enable HTTPS</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_NETWORK_CERTPATH</code></td> <td><code>TRILIUM_NETWORK_CERTPATH</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>SSL certificate path</td> <td>SSL certificate path</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_NETWORK_KEYPATH</code></td> <td><code>TRILIUM_NETWORK_KEYPATH</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>SSL key path</td> <td>SSL key path</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_NETWORK_TRUSTEDREVERSEPROXY</code></td> <td><code>TRILIUM_NETWORK_TRUSTEDREVERSEPROXY</code>
</td>
<td>boolean/string</td> <td>boolean/string</td>
<td>false</td> <td>false</td>
<td>Reverse proxy trust settings</td> <td>Reverse proxy trust settings</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_NETWORK_CORSALLOWORIGIN</code></td> <td><code>TRILIUM_NETWORK_CORSALLOWORIGIN</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>CORS allowed origins</td> <td>CORS allowed origins</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_NETWORK_CORSALLOWMETHODS</code></td> <td><code>TRILIUM_NETWORK_CORSALLOWMETHODS</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>CORS allowed methods</td> <td>CORS allowed methods</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_NETWORK_CORSALLOWHEADERS</code></td> <td><code>TRILIUM_NETWORK_CORSALLOWHEADERS</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>CORS allowed headers</td> <td>CORS allowed headers</td>
@@ -143,7 +162,8 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><code>TRILIUM_SESSION_COOKIEMAXAGE</code></td> <td><code>TRILIUM_SESSION_COOKIEMAXAGE</code>
</td>
<td>integer</td> <td>integer</td>
<td>1814400</td> <td>1814400</td>
<td>Session cookie max age in seconds (21 days)</td> <td>Session cookie max age in seconds (21 days)</td>
@@ -163,19 +183,22 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><code>TRILIUM_SYNC_SYNCSERVERHOST</code></td> <td><code>TRILIUM_SYNC_SYNCSERVERHOST</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>Sync server host URL</td> <td>Sync server host URL</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_SYNC_SYNCSERVERTIMEOUT</code></td> <td><code>TRILIUM_SYNC_SYNCSERVERTIMEOUT</code>
</td>
<td>string</td> <td>string</td>
<td>"120000"</td> <td>"120000"</td>
<td>Sync server timeout in milliseconds</td> <td>Sync server timeout in milliseconds</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_SYNC_SYNCPROXY</code></td> <td><code>TRILIUM_SYNC_SYNCPROXY</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>Sync proxy URL</td> <td>Sync proxy URL</td>
@@ -195,37 +218,43 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code></td> <td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>OAuth/OpenID base URL</td> <td>OAuth/OpenID base URL</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID</code></td> <td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>OAuth client ID</td> <td>OAuth client ID</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET</code></td> <td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>OAuth client secret</td> <td>OAuth client secret</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL</code></td> <td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL</code>
</td>
<td>string</td> <td>string</td>
<td>"https://accounts.google.com"</td> <td>"<a href="https://accounts.google.com">https://accounts.google.com</a>"</td>
<td>OAuth issuer base URL</td> <td>OAuth issuer base URL</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code></td> <td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code>
</td>
<td>string</td> <td>string</td>
<td>"Google"</td> <td>"Google"</td>
<td>OAuth issuer display name</td> <td>OAuth issuer display name</td>
</tr> </tr>
<tr> <tr>
<td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code></td> <td><code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code>
</td>
<td>string</td> <td>string</td>
<td>""</td> <td>""</td>
<td>OAuth issuer icon URL</td> <td>OAuth issuer icon URL</td>
@@ -245,7 +274,8 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><code>TRILIUM_LOGGING_RETENTIONDAYS</code></td> <td><code>TRILIUM_LOGGING_RETENTIONDAYS</code>
</td>
<td>integer</td> <td>integer</td>
<td>90</td> <td>90</td>
<td>Number of days to retain log files</td> <td>Number of days to retain log files</td>
@@ -254,22 +284,20 @@
</table> </table>
<h2>Alternative Environment Variables</h2> <h2>Alternative Environment Variables</h2>
<p>The following alternative environment variable names are also supported and work identically to their longer counterparts:</p> <p>The following alternative environment variable names are also supported
and work identically to their longer counterparts:</p>
<h3>Network CORS Variables</h3> <h3>Network CORS Variables</h3>
<ul> <ul>
<li><code>TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWORIGIN</code>)</li> <li><code>TRILIUM_NETWORK_CORS_ALLOW_ORIGIN</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWORIGIN</code>)</li>
<li><code>TRILIUM_NETWORK_CORS_ALLOW_METHODS</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWMETHODS</code>)</li> <li><code>TRILIUM_NETWORK_CORS_ALLOW_METHODS</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWMETHODS</code>)</li>
<li><code>TRILIUM_NETWORK_CORS_ALLOW_HEADERS</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWHEADERS</code>)</li> <li><code>TRILIUM_NETWORK_CORS_ALLOW_HEADERS</code> (alternative to <code>TRILIUM_NETWORK_CORSALLOWHEADERS</code>)</li>
</ul> </ul>
<h3>Sync Variables</h3> <h3>Sync Variables</h3>
<ul> <ul>
<li><code>TRILIUM_SYNC_SERVER_HOST</code> (alternative to <code>TRILIUM_SYNC_SYNCSERVERHOST</code>)</li> <li><code>TRILIUM_SYNC_SERVER_HOST</code> (alternative to <code>TRILIUM_SYNC_SYNCSERVERHOST</code>)</li>
<li><code>TRILIUM_SYNC_SERVER_TIMEOUT</code> (alternative to <code>TRILIUM_SYNC_SYNCSERVERTIMEOUT</code>)</li> <li><code>TRILIUM_SYNC_SERVER_TIMEOUT</code> (alternative to <code>TRILIUM_SYNC_SYNCSERVERTIMEOUT</code>)</li>
<li><code>TRILIUM_SYNC_SERVER_PROXY</code> (alternative to <code>TRILIUM_SYNC_SYNCPROXY</code>)</li> <li><code>TRILIUM_SYNC_SERVER_PROXY</code> (alternative to <code>TRILIUM_SYNC_SYNCPROXY</code>)</li>
</ul> </ul>
<h3>OAuth/MFA Variables</h3> <h3>OAuth/MFA Variables</h3>
<ul> <ul>
<li><code>TRILIUM_OAUTH_BASE_URL</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code>)</li> <li><code>TRILIUM_OAUTH_BASE_URL</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code>)</li>
@@ -279,32 +307,30 @@
<li><code>TRILIUM_OAUTH_ISSUER_NAME</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code>)</li> <li><code>TRILIUM_OAUTH_ISSUER_NAME</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code>)</li>
<li><code>TRILIUM_OAUTH_ISSUER_ICON</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code>)</li> <li><code>TRILIUM_OAUTH_ISSUER_ICON</code> (alternative to <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code>)</li>
</ul> </ul>
<h3>Logging Variables</h3> <h3>Logging Variables</h3>
<ul> <ul>
<li><code>TRILIUM_LOGGING_RETENTION_DAYS</code> (alternative to <code>TRILIUM_LOGGING_RETENTIONDAYS</code>)</li> <li><code>TRILIUM_LOGGING_RETENTION_DAYS</code> (alternative to <code>TRILIUM_LOGGING_RETENTIONDAYS</code>)</li>
</ul> </ul>
<h2>Boolean Values</h2> <h2>Boolean Values</h2>
<p>Boolean environment variables accept the following values:</p> <p>Boolean environment variables accept the following values:</p>
<ul> <ul>
<li><strong>True</strong>: <code>"true"</code>, <code>"1"</code>, <code>1</code></li> <li><strong>True</strong>: <code>"true"</code>, <code>"1"</code>, <code>1</code>
<li><strong>False</strong>: <code>"false"</code>, <code>"0"</code>, <code>0</code></li> </li>
<li>Any other value defaults to <code>false</code></li> <li><strong>False</strong>: <code>"false"</code>, <code>"0"</code>, <code>0</code>
</li>
<li>Any other value defaults to <code>false</code>
</li>
</ul> </ul>
<h2>Using Environment Variables</h2> <h2>Using Environment Variables</h2>
<p>Both naming patterns are fully supported and can be used interchangeably:</p> <p>Both naming patterns are fully supported and can be used interchangeably:</p>
<ul> <ul>
<li>The longer format follows the section/key pattern for consistency with the INI file structure</li> <li>The longer format follows the section/key pattern for consistency with
the INI file structure</li>
<li>The shorter alternatives provide convenience for common configurations</li> <li>The shorter alternatives provide convenience for common configurations</li>
<li>You can use whichever format you prefer - both are equally valid</li> <li>You can use whichever format you prefer - both are equally valid</li>
</ul> </ul>
<h2>Examples</h2> <h2>Examples</h2>
<h3>Docker Compose Example</h3><pre><code class="language-text-x-yaml">services:
<h3>Docker Compose Example</h3>
<pre><code class="language-yaml">services:
trilium: trilium:
image: triliumnext/notes image: triliumnext/notes
environment: environment:
@@ -319,9 +345,7 @@
# TRILIUM_NETWORK_CORS_ALLOW_ORIGIN: "https://myapp.com" # TRILIUM_NETWORK_CORS_ALLOW_ORIGIN: "https://myapp.com"
# TRILIUM_SYNC_SERVER_HOST: "https://sync.example.com" # TRILIUM_SYNC_SERVER_HOST: "https://sync.example.com"
# TRILIUM_OAUTH_BASE_URL: "https://auth.example.com"</code></pre> # TRILIUM_OAUTH_BASE_URL: "https://auth.example.com"</code></pre>
<h3>Shell Export Example</h3><pre><code class="language-text-x-sh"># Using either format
<h3>Shell Export Example</h3>
<pre><code class="language-bash"># Using either format
export TRILIUM_GENERAL_NOAUTHENTICATION=false export TRILIUM_GENERAL_NOAUTHENTICATION=false
export TRILIUM_NETWORK_HTTPS=true export TRILIUM_NETWORK_HTTPS=true
export TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem export TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem
@@ -330,6 +354,7 @@ export TRILIUM_LOGGING_RETENTIONDAYS=30
# Start Trilium # Start Trilium
npm start</code></pre> npm start</code></pre>
<h2>config.ini Reference</h2> <h2>config.ini Reference</h2>
<p>For the complete list of configuration options and their INI file format, please review the <a href="https://github.com/TriliumNext/Trilium/blob/main/apps/server/src/assets/config-sample.ini">config-sample.ini</a> file in the Trilium repository.</p> <p>For the complete list of configuration options and their INI file format,
please review the <a href="https://github.com/TriliumNext/Trilium/blob/main/apps/server/src/assets/config-sample.ini">config-sample.ini</a> file
in the Trilium repository</p>

132
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Navigation/Quick search.html generated vendored
View File

@@ -5,18 +5,19 @@
<p>The <em>Quick search</em> function does a full-text search (that is, it <p>The <em>Quick search</em> function does a full-text search (that is, it
searches through the content of notes and not just the title of a note) searches through the content of notes and not just the title of a note)
and displays the result in an easy-to-access manner.</p> and displays the result in an easy-to-access manner.</p>
<p>The alternative to the quick search is the <a class="reference-link" href="#root/_help_eIg8jdvaoNNd">Search</a> function, <p>The alternative to the quick search is the&nbsp;<a class="reference-link"
which opens in a dedicated tab and has support for advanced queries.</p> href="#root/_help_eIg8jdvaoNNd">Search</a>&nbsp;function, which opens in
<p>For even faster navigation, it's possible to use <a class="reference-link" a dedicated tab and has support for advanced queries.</p>
href="#root/_help_F1r9QtzQLZqm">Jump to Note</a> which will only search <p>For even faster navigation, it's possible to use&nbsp;<a class="reference-link"
href="#root/_help_F1r9QtzQLZqm">Jump to...</a>&nbsp;which will only search
through the note titles instead of the content.</p> through the note titles instead of the content.</p>
<h2>Layout</h2> <h2>Layout</h2>
<p>Based on the <a class="reference-link" href="#root/_help_x0JgW8UqGXvq">Vertical and horizontal layout</a>, <p>Based on the&nbsp;<a class="reference-link" href="#root/_help_x0JgW8UqGXvq">Vertical and horizontal layout</a>,
the quick search is placed:</p> the quick search is placed:</p>
<ul> <ul>
<li>On the vertical layout, it is displayed right above the <a class="reference-link" <li data-list-item-id="eb498e0518c4efc433c9569270c9c7a5c">On the vertical layout, it is displayed right above the&nbsp;<a class="reference-link"
href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li> href="#root/_help_oPVyFC7WL2Lp">Note Tree</a>.</li>
<li>On the horizontal layout, it is displayed in the <a class="reference-link" <li data-list-item-id="e6a9159606a513e839ca71ff4735857bb">On the horizontal layout, it is displayed in the&nbsp;<a class="reference-link"
href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>, where it can be positioned href="#root/_help_xYmIYSP6wE3F">Launch Bar</a>, where it can be positioned
just like any other icon.</li> just like any other icon.</li>
</ul> </ul>
@@ -30,37 +31,120 @@
<h3>Infinite Scrolling</h3> <h3>Infinite Scrolling</h3>
<p>Results are loaded progressively as you scroll:</p> <p>Results are loaded progressively as you scroll:</p>
<ul> <ul>
<li>Initial display shows 15 results</li> <li data-list-item-id="e6d151aab6b52d08e9a93e6f9c29c081a">Initial display shows 15 results</li>
<li>Scrolling near the bottom automatically loads 10 more results</li> <li data-list-item-id="e006eeac7574a398324f214edcb9a383b">Scrolling near the bottom automatically loads 10 more results</li>
<li>Continue scrolling to load all matching notes</li> <li
data-list-item-id="e5f6fcb1ec0d496fcf599fa90c3911c89">Continue scrolling to load all matching notes</li>
</ul> </ul>
<h3>Visual Features</h3> <h3>Visual Features</h3>
<ul> <ul>
<li><strong>Highlighting</strong>: Search terms appear in bold with accent <li data-list-item-id="e44f3402a55ac37c63abae20490d66d70"><strong>Highlighting</strong>: Search terms appear in bold with accent
colors</li> colors</li>
<li><strong>Separation</strong>: Results are separated with dividers</li> <li data-list-item-id="e1c8743ac639f15750171788790df2bb0"><strong>Separation</strong>: Results are separated with dividers</li>
<li><strong>Theme Support</strong>: Highlighting colors adapt to light/dark <li
data-list-item-id="ec5c5dbaa44ba426d220718804b9b27db"><strong>Theme Support</strong>: Highlighting colors adapt to light/dark
themes</li> themes</li>
</ul> </ul>
<h3>Search Behavior</h3> <h3>Search Behavior</h3>
<p>Quick search uses progressive search:</p> <p>Quick search uses progressive search:</p>
<ol> <ol>
<li>Shows exact matches first</li> <li data-list-item-id="e9a34edaccc0174140e1183c5e43a2327">Shows exact matches first</li>
<li>Includes fuzzy matches when exact results are fewer than 5</li> <li data-list-item-id="e5b751c044ae5189095fd08655a55372f">Includes fuzzy matches when exact results are fewer than 5</li>
<li>Exact matches appear before fuzzy matches</li> <li data-list-item-id="ee63c39a04b7511cd4e031cdd963f58d2">Exact matches appear before fuzzy matches</li>
</ol> </ol>
<h3>Keyboard Navigation</h3> <h3>Keyboard Navigation</h3>
<ul> <ul>
<li>Press <code>Enter</code> to open the first result</li> <li data-list-item-id="e1161754a60afdea3656561abcb46f9ea">Press <code>Enter</code> to open the first result</li>
<li>Use arrow keys to navigate through results</li> <li data-list-item-id="ebdffa32bcd3d8e24c3938b472521034d">Use arrow keys to navigate through results</li>
<li>Press <code>Escape</code> to close the quick search</li> <li data-list-item-id="eed08e1e6867dcef7eaa6ce7a21fd5e02">Press <code>Escape</code> to close the quick search</li>
</ul> </ul>
<h2>Using Quick Search</h2> <h2>Using Quick Search</h2>
<ol> <ol>
<li><strong>Typo tolerance</strong>: Search finds results despite minor typos</li> <li data-list-item-id="e88738101cdad95c7ffe2fc45d19250b7"><strong>Typo tolerance</strong>: Search finds results despite minor typos</li>
<li><strong>Content previews</strong>: 200-character snippets show match context</li> <li
<li><strong>Infinite scrolling</strong>: Additional results load on scroll</li> data-list-item-id="ead4c50c8ae5e86987073741285271140"><strong>Content previews</strong>: 200-character snippets show match context</li>
<li><strong>Specific terms</strong>: Specific search terms return more focused <li
data-list-item-id="ee135ac66eafef5962b5221fa149dc31c"><strong>Infinite scrolling</strong>: Additional results load on scroll</li>
<li
data-list-item-id="ebecf1647bb3e6631383fa1cad5e0d222"><strong>Specific terms</strong>: Specific search terms return more focused
results</li> results</li>
<li><strong>Match locations</strong>: Bold text indicates where matches occur</li> <li data-list-item-id="e7d6ee3a67dbf55e7c72788cde795f2b2"><strong>Match locations</strong>: Bold text indicates where matches occur</li>
</ol> </ol>
<h2>Quick Search - Exact Match Operator</h2>
<p>Quick Search now supports the exact match operator (<code>=</code>) at
the beginning of your search query. This allows you to search for notes
where the title or content exactly matches your search term, rather than
just containing it.</p>
<h3>Usage</h3>
<p>To use exact match in Quick Search:</p>
<ol>
<li data-list-item-id="e98c91a13502a0ddd321432cd2cdab193">Start your search query with the <code>=</code> operator</li>
<li data-list-item-id="e0db9fc3f530c8e0eb96f4df5ef74d955">Follow it immediately with your search term (no space after <code>=</code>)</li>
</ol>
<h4>Examples</h4>
<ul>
<li data-list-item-id="e188d5c0a39291e2f665072b02b4b6cc0"><code>=example</code> - Finds notes with title exactly "example" or content
exactly "example"</li>
<li data-list-item-id="e275568bc5123c979fddff51fac370983"><code>=Project Plan</code> - Finds notes with title exactly "Project Plan"
or content exactly "Project Plan"</li>
<li data-list-item-id="e04c10070d9800148f641efcbee16ab3d"><code>='hello world'</code> - Use quotes for multi-word exact matches</li>
</ul>
<h4>Comparison with Regular Search</h4>
<figure class="table">
<table>
<thead>
<tr>
<th>Query</th>
<th>Behavior</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>example</code>
</td>
<td>Finds all notes containing "example" anywhere in title or content</td>
</tr>
<tr>
<td><code>=example</code>
</td>
<td>Finds only notes where the title equals "example" or content equals "example"
exactly</td>
</tr>
</tbody>
</table>
</figure>
<h3>Technical Details</h3>
<p>When you use the <code>=</code> operator:</p>
<ul>
<li data-list-item-id="ebd357e2f6afa77ccb3aed347103d47c3">The search performs an exact match on note titles</li>
<li data-list-item-id="e64c84d77017e4cd43fe95c0e4f537044">For note content, it looks for exact matches of the entire content</li>
<li
data-list-item-id="ef4f790816f24b9484fea127837025935">Partial word matches are excluded</li>
<li data-list-item-id="e94a53c59dc4f1a8bef101df66538d06a">The search is case-insensitive</li>
</ul>
<h3>Limitations</h3>
<ul>
<li data-list-item-id="e4ed2c12de6681eb26d2ec2daa1985956">The <code>=</code> operator must be at the very beginning of the search
query</li>
<li data-list-item-id="e30845adb77a12106475b88b68b614009">Spaces after <code>=</code> will treat it as a regular search</li>
<li data-list-item-id="e89322d60b3f5cb6b2b318cc7247721cf">Multiple <code>=</code> operators (like <code>==example</code>) are treated
as regular text search</li>
</ul>
<h3>Use Cases</h3>
<p>This feature is particularly useful when:</p>
<ul>
<li data-list-item-id="eb23079c90785534a68963977e993d253">You know the exact title of a note</li>
<li data-list-item-id="e92f02cb8b28fc02f264ebeb09376af91">You want to find notes with specific, complete content</li>
<li data-list-item-id="e37aa1707a8440213fe404d1ed7a2e941">You need to distinguish between notes with similar but not identical titles</li>
<li
data-list-item-id="e8b04a0a97aa970e6984370ff17160208">You want to avoid false positives from partial matches</li>
</ul>
<h3>Related Features</h3>
<ul>
<li data-list-item-id="e3d0656590d49c6e09ae5f39a0a773dff">For more complex exact matching queries, use the full <a href="Search.md">Search</a> functionality</li>
<li
data-list-item-id="e7d77021ebedb1b1d25e8bfe2726af21e">For fuzzy matching (finding results despite typos), use the <code>~=</code> operator
in the full search</li>
<li data-list-item-id="eabcf1ff7a9dfa822192ee9afe3268469">For partial matches with wildcards, use operators like <code>*=*</code>, <code>=*</code>,
or <code>*=</code> in the full search</li>
</ul>

3
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.html generated vendored
View File

@@ -134,7 +134,8 @@ docker run -d --name trilium -p 8080:8080 --user $(id -u):$(id -g) -v ~/trilium-
<li><code>TRILIUM_DATA_DIR</code>: Path to the data directory inside the container <li><code>TRILIUM_DATA_DIR</code>: Path to the data directory inside the container
(default: <code>/home/node/trilium-data</code>)</li> (default: <code>/home/node/trilium-data</code>)</li>
</ul> </ul>
<p>For a complete list of configuration environment variables (network settings, authentication, sync, etc.), see <a class="reference-link" href="#root/_help_Gzjqa934BdH4">Configuration (config.ini or environment variables)</a>.</p> <p>For a complete list of configuration environment variables (network settings,
authentication, sync, etc.), see <a class="reference-link" href="#root/_help_dmi3wz9muS2O">Configuration (config.ini or environment variables)</a>.</p>
<h3>Volume Permissions</h3> <h3>Volume Permissions</h3>
<p>If you encounter permission issues with the data volume, ensure that:</p> <p>If you encounter permission issues with the data volume, ensure that:</p>
<ol> <ol>

18
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.html generated vendored
View File

@@ -51,8 +51,10 @@ class="admonition warning">
<ol> <ol>
<li>You can also setup through environment variables: <li>You can also setup through environment variables:
<ul> <ul>
<li>Standard: <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code>, <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID</code>, <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET</code></li> <li>Standard: <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL</code>, <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID</code>, <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET</code>
<li>Legacy (still supported): <code>TRILIUM_OAUTH_BASE_URL</code>, <code>TRILIUM_OAUTH_CLIENT_ID</code>, <code>TRILIUM_OAUTH_CLIENT_SECRET</code></li> </li>
<li>Legacy (still supported): <code>TRILIUM_OAUTH_BASE_URL</code>, <code>TRILIUM_OAUTH_CLIENT_ID</code>, <code>TRILIUM_OAUTH_CLIENT_SECRET</code>
</li>
</ul> </ul>
</li> </li>
<li><code>oauthBaseUrl</code> should be the link of your Trilium instance server, <li><code>oauthBaseUrl</code> should be the link of your Trilium instance server,
@@ -69,13 +71,15 @@ class="admonition warning">
<p>The default OAuth issuer is Google. To use other services such as Authentik <p>The default OAuth issuer is Google. To use other services such as Authentik
or Auth0, you can configure the settings via <code>oauthIssuerBaseUrl</code>, <code>oauthIssuerName</code>, or Auth0, you can configure the settings via <code>oauthIssuerBaseUrl</code>, <code>oauthIssuerName</code>,
and <code>oauthIssuerIcon</code> in the <code>config.ini</code> file. Alternatively, and <code>oauthIssuerIcon</code> in the <code>config.ini</code> file. Alternatively,
these values can be set using environment variables: these values can be set using environment variables:</p>
<ul> <ul>
<li>Standard: <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL</code>, <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code>, <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code></li> <li>Standard: <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL</code>, <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME</code>, <code>TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON</code>
<li>Legacy (still supported): <code>TRILIUM_OAUTH_ISSUER_BASE_URL</code>, <code>TRILIUM_OAUTH_ISSUER_NAME</code>, <code>TRILIUM_OAUTH_ISSUER_ICON</code></li> </li>
<li>Legacy (still supported): <code>TRILIUM_OAUTH_ISSUER_BASE_URL</code>, <code>TRILIUM_OAUTH_ISSUER_NAME</code>, <code>TRILIUM_OAUTH_ISSUER_ICON</code>
</li>
</ul> </ul>
<code>oauthIssuerName</code> and <code>oauthIssuerIcon</code> are <p><code>oauthIssuerName</code> and <code>oauthIssuerIcon</code> are required
required for displaying correct issuer information at the Login page.</p> for displaying correct issuer information at the Login page.</p>
</aside> </aside>
<h4>Authentik</h4> <h4>Authentik</h4>
<p>If you don’t already have a running Authentik instance, please follow <p>If you don’t already have a running Authentik instance, please follow

4
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/TLS Configuration.html generated vendored
View File

@@ -26,8 +26,8 @@ https=true
certPath=/[username]/.acme.sh/[hostname]/fullchain.cer certPath=/[username]/.acme.sh/[hostname]/fullchain.cer
keyPath=/[username]/.acme.sh/[hostname]/example.com.key</code></pre> keyPath=/[username]/.acme.sh/[hostname]/example.com.key</code></pre>
<p>You can also review the <a href="#root/_help_Gzjqa934BdH4">configuration</a> file <p>You can also review the <a href="#root/_help_Gzjqa934BdH4">configuration</a> file
to provide all <code>config.ini</code> values as environment variables instead. For example, you can configure TLS using environment variables:</p> to provide all <code>config.ini</code> values as environment variables instead.
<pre><code class="language-bash">export TRILIUM_NETWORK_HTTPS=true For example, you can configure TLS using environment variables:</p><pre><code class="language-text-x-sh">export TRILIUM_NETWORK_HTTPS=true
export TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem export TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem
export TRILIUM_NETWORK_KEYPATH=/path/to/key.pem</code></pre> export TRILIUM_NETWORK_KEYPATH=/path/to/key.pem</code></pre>
<p>The above example shows how this is set up in an environment where the <p>The above example shows how this is set up in an environment where the

2
docs/Developer Guide/!!!meta.json vendored
View File

@@ -1,6 +1,6 @@
{ {
"formatVersion": 2, "formatVersion": 2,
"appVersion": "0.97.2", "appVersion": "0.98.0",
"files": [ "files": [
{ {
"isClone": false, "isClone": false,

2
docs/Release Notes/!!!meta.json vendored
View File

@@ -1,6 +1,6 @@
{ {
"formatVersion": 2, "formatVersion": 2,
"appVersion": "0.97.2", "appVersion": "0.98.0",
"files": [ "files": [
{ {
"isClone": false, "isClone": false,

2
docs/Release Notes/Release Notes/v0.98.0.md vendored
View File

@@ -44,12 +44,14 @@
## 🌍 Internationalization ## 🌍 Internationalization
* Improvements to multiple languages: * Improvements to multiple languages:
* Chinese (Traditional) * Chinese (Traditional)
* Spanish * Spanish
* Some work started on new languages: * Some work started on new languages:
Portuguese (Brazil), Japanese, Russian, Serbian, Italian, Greek, Catalan Portuguese (Brazil), Japanese, Russian, Serbian, Italian, Greek, Catalan
* Added new languages: * Added new languages:
* Russian (translations by @questamor) * Russian (translations by @questamor)
* Japanese language (translations by [acwr47](https://hosted.weblate.org/user/acwr47/))\[…\] * Japanese language (translations by [acwr47](https://hosted.weblate.org/user/acwr47/))\[…\]

2
docs/User Guide/!!!meta.json vendored
View File

@@ -1,6 +1,6 @@
{ {
"formatVersion": 2, "formatVersion": 2,
"appVersion": "0.97.2", "appVersion": "0.98.0",
"files": [ "files": [
{ {
"isClone": false, "isClone": false,

68
docs/User Guide/User Guide/Advanced Usage/Configuration (config.ini or e.md vendored
View File

@@ -1,10 +1,10 @@
# Configuration (config.ini or environment variables) # Configuration (config.ini or environment variables)
Trilium supports configuration via a file named `config.ini` and environment variables. This document provides a comprehensive reference for all configuration options. Trilium supports configuration via a file named `config.ini` and environment variables. This document provides a comprehensive reference for all configuration options.
## Configuration Precedence ## Configuration Precedence
Configuration values are loaded in the following order of precedence (highest to lowest): Configuration values are loaded in the following order of precedence (highest to lowest):
1. **Environment variables** (checked first) 1. **Environment variables** (checked first)
2. **config.ini file values** 2. **config.ini file values**
3. **Default values** 3. **Default values**
@@ -14,8 +14,9 @@ Configuration values are loaded in the following order of precedence (highest to
Trilium supports multiple environment variable patterns for flexibility. The primary pattern is: `TRILIUM_[SECTION]_[KEY]` Trilium supports multiple environment variable patterns for flexibility. The primary pattern is: `TRILIUM_[SECTION]_[KEY]`
Where: Where:
- `SECTION` is the INI section name in UPPERCASE
- `KEY` is the camelCase configuration key converted to UPPERCASE (e.g., `instanceName` → `INSTANCENAME`) * `SECTION` is the INI section name in UPPERCASE
* `KEY` is the camelCase configuration key converted to UPPERCASE (e.g., `instanceName` → `INSTANCENAME`)
Additionally, shorter aliases are available for common configurations (see Alternative Variables section below). Additionally, shorter aliases are available for common configurations (see Alternative Variables section below).
@@ -24,7 +25,7 @@ Additionally, shorter aliases are available for common configurations (see Alter
### General Section ### General Section
| Environment Variable | Type | Default | Description | | Environment Variable | Type | Default | Description |
|------------------|------|---------|-------------| | --- | --- | --- | --- |
| `TRILIUM_GENERAL_INSTANCENAME` | string | "" | Instance name for API identification | | `TRILIUM_GENERAL_INSTANCENAME` | string | "" | Instance name for API identification |
| `TRILIUM_GENERAL_NOAUTHENTICATION` | boolean | false | Disable authentication (server only) | | `TRILIUM_GENERAL_NOAUTHENTICATION` | boolean | false | Disable authentication (server only) |
| `TRILIUM_GENERAL_NOBACKUP` | boolean | false | Disable automatic backups | | `TRILIUM_GENERAL_NOBACKUP` | boolean | false | Disable automatic backups |
@@ -34,7 +35,7 @@ Additionally, shorter aliases are available for common configurations (see Alter
### Network Section ### Network Section
| Environment Variable | Type | Default | Description | | Environment Variable | Type | Default | Description |
|------------------|------|---------|-------------| | --- | --- | --- | --- |
| `TRILIUM_NETWORK_HOST` | string | "0.0.0.0" | Server host binding | | `TRILIUM_NETWORK_HOST` | string | "0.0.0.0" | Server host binding |
| `TRILIUM_NETWORK_PORT` | string | "3000" | Server port | | `TRILIUM_NETWORK_PORT` | string | "3000" | Server port |
| `TRILIUM_NETWORK_HTTPS` | boolean | false | Enable HTTPS | | `TRILIUM_NETWORK_HTTPS` | boolean | false | Enable HTTPS |
@@ -48,13 +49,13 @@ Additionally, shorter aliases are available for common configurations (see Alter
### Session Section ### Session Section
| Environment Variable | Type | Default | Description | | Environment Variable | Type | Default | Description |
|------------------|------|---------|-------------| | --- | --- | --- | --- |
| `TRILIUM_SESSION_COOKIEMAXAGE` | integer | 1814400 | Session cookie max age in seconds (21 days) | | `TRILIUM_SESSION_COOKIEMAXAGE` | integer | 1814400 | Session cookie max age in seconds (21 days) |
### Sync Section ### Sync Section
| Environment Variable | Type | Default | Description | | Environment Variable | Type | Default | Description |
|------------------|------|---------|-------------| | --- | --- | --- | --- |
| `TRILIUM_SYNC_SYNCSERVERHOST` | string | "" | Sync server host URL | | `TRILIUM_SYNC_SYNCSERVERHOST` | string | "" | Sync server host URL |
| `TRILIUM_SYNC_SYNCSERVERTIMEOUT` | string | "120000" | Sync server timeout in milliseconds | | `TRILIUM_SYNC_SYNCSERVERTIMEOUT` | string | "120000" | Sync server timeout in milliseconds |
| `TRILIUM_SYNC_SYNCPROXY` | string | "" | Sync proxy URL | | `TRILIUM_SYNC_SYNCPROXY` | string | "" | Sync proxy URL |
@@ -62,18 +63,18 @@ Additionally, shorter aliases are available for common configurations (see Alter
### MultiFactorAuthentication Section ### MultiFactorAuthentication Section
| Environment Variable | Type | Default | Description | | Environment Variable | Type | Default | Description |
|------------------|------|---------|-------------| | --- | --- | --- | --- |
| `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL` | string | "" | OAuth/OpenID base URL | | `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL` | string | "" | OAuth/OpenID base URL |
| `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID` | string | "" | OAuth client ID | | `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID` | string | "" | OAuth client ID |
| `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET` | string | "" | OAuth client secret | | `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET` | string | "" | OAuth client secret |
| `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL` | string | "https://accounts.google.com" | OAuth issuer base URL | | `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL` | string | "[https://accounts.google.com](https://accounts.google.com)" | OAuth issuer base URL |
| `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME` | string | "Google" | OAuth issuer display name | | `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME` | string | "Google" | OAuth issuer display name |
| `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON` | string | "" | OAuth issuer icon URL | | `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON` | string | "" | OAuth issuer icon URL |
### Logging Section ### Logging Section
| Environment Variable | Type | Default | Description | | Environment Variable | Type | Default | Description |
|------------------|------|---------|-------------| | --- | --- | --- | --- |
| `TRILIUM_LOGGING_RETENTIONDAYS` | integer | 90 | Number of days to retain log files | | `TRILIUM_LOGGING_RETENTIONDAYS` | integer | 90 | Number of days to retain log files |
## Alternative Environment Variables ## Alternative Environment Variables
@@ -81,44 +82,50 @@ Additionally, shorter aliases are available for common configurations (see Alter
The following alternative environment variable names are also supported and work identically to their longer counterparts: The following alternative environment variable names are also supported and work identically to their longer counterparts:
### Network CORS Variables ### Network CORS Variables
- `TRILIUM_NETWORK_CORS_ALLOW_ORIGIN` (alternative to `TRILIUM_NETWORK_CORSALLOWORIGIN`)
- `TRILIUM_NETWORK_CORS_ALLOW_METHODS` (alternative to `TRILIUM_NETWORK_CORSALLOWMETHODS`) * `TRILIUM_NETWORK_CORS_ALLOW_ORIGIN` (alternative to `TRILIUM_NETWORK_CORSALLOWORIGIN`)
- `TRILIUM_NETWORK_CORS_ALLOW_HEADERS` (alternative to `TRILIUM_NETWORK_CORSALLOWHEADERS`) * `TRILIUM_NETWORK_CORS_ALLOW_METHODS` (alternative to `TRILIUM_NETWORK_CORSALLOWMETHODS`)
* `TRILIUM_NETWORK_CORS_ALLOW_HEADERS` (alternative to `TRILIUM_NETWORK_CORSALLOWHEADERS`)
### Sync Variables ### Sync Variables
- `TRILIUM_SYNC_SERVER_HOST` (alternative to `TRILIUM_SYNC_SYNCSERVERHOST`)
- `TRILIUM_SYNC_SERVER_TIMEOUT` (alternative to `TRILIUM_SYNC_SYNCSERVERTIMEOUT`) * `TRILIUM_SYNC_SERVER_HOST` (alternative to `TRILIUM_SYNC_SYNCSERVERHOST`)
- `TRILIUM_SYNC_SERVER_PROXY` (alternative to `TRILIUM_SYNC_SYNCPROXY`) * `TRILIUM_SYNC_SERVER_TIMEOUT` (alternative to `TRILIUM_SYNC_SYNCSERVERTIMEOUT`)
* `TRILIUM_SYNC_SERVER_PROXY` (alternative to `TRILIUM_SYNC_SYNCPROXY`)
### OAuth/MFA Variables ### OAuth/MFA Variables
- `TRILIUM_OAUTH_BASE_URL` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL`)
- `TRILIUM_OAUTH_CLIENT_ID` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID`) * `TRILIUM_OAUTH_BASE_URL` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL`)
- `TRILIUM_OAUTH_CLIENT_SECRET` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET`) * `TRILIUM_OAUTH_CLIENT_ID` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID`)
- `TRILIUM_OAUTH_ISSUER_BASE_URL` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL`) * `TRILIUM_OAUTH_CLIENT_SECRET` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET`)
- `TRILIUM_OAUTH_ISSUER_NAME` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME`) * `TRILIUM_OAUTH_ISSUER_BASE_URL` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL`)
- `TRILIUM_OAUTH_ISSUER_ICON` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON`) * `TRILIUM_OAUTH_ISSUER_NAME` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME`)
* `TRILIUM_OAUTH_ISSUER_ICON` (alternative to `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON`)
### Logging Variables ### Logging Variables
- `TRILIUM_LOGGING_RETENTION_DAYS` (alternative to `TRILIUM_LOGGING_RETENTIONDAYS`)
* `TRILIUM_LOGGING_RETENTION_DAYS` (alternative to `TRILIUM_LOGGING_RETENTIONDAYS`)
## Boolean Values ## Boolean Values
Boolean environment variables accept the following values: Boolean environment variables accept the following values:
- **True**: `"true"`, `"1"`, `1`
- **False**: `"false"`, `"0"`, `0` * **True**: `"true"`, `"1"`, `1`
- Any other value defaults to `false` * **False**: `"false"`, `"0"`, `0`
* Any other value defaults to `false`
## Using Environment Variables ## Using Environment Variables
Both naming patterns are fully supported and can be used interchangeably: Both naming patterns are fully supported and can be used interchangeably:
- The longer format follows the section/key pattern for consistency with the INI file structure * The longer format follows the section/key pattern for consistency with the INI file structure
- The shorter alternatives provide convenience for common configurations * The shorter alternatives provide convenience for common configurations
- You can use whichever format you prefer - both are equally valid * You can use whichever format you prefer - both are equally valid
## Examples ## Examples
### Docker Compose Example ### Docker Compose Example
```yaml ```yaml
services: services:
trilium: trilium:
@@ -138,7 +145,8 @@ services:
``` ```
### Shell Export Example ### Shell Export Example
```bash
```sh
# Using either format # Using either format
export TRILIUM_GENERAL_NOAUTHENTICATION=false export TRILIUM_GENERAL_NOAUTHENTICATION=false
export TRILIUM_NETWORK_HTTPS=true export TRILIUM_NETWORK_HTTPS=true

53
docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Quick search - Exact Match.md vendored
View File

@@ -1,53 +0,0 @@
# Quick Search - Exact Match Operator
## Overview
Quick Search now supports the exact match operator (`=`) at the beginning of your search query. This allows you to search for notes where the title or content exactly matches your search term, rather than just containing it.
## Usage
To use exact match in Quick Search:
1. Start your search query with the `=` operator
2. Follow it immediately with your search term (no space after `=`)
### Examples
- `=example` - Finds notes with title exactly "example" or content exactly "example"
- `=Project Plan` - Finds notes with title exactly "Project Plan" or content exactly "Project Plan"
- `='hello world'` - Use quotes for multi-word exact matches
### Comparison with Regular Search
| Query | Behavior |
|-------|----------|
| `example` | Finds all notes containing "example" anywhere in title or content |
| `=example` | Finds only notes where the title equals "example" or content equals "example" exactly |
## Technical Details
When you use the `=` operator:
- The search performs an exact match on note titles
- For note content, it looks for exact matches of the entire content
- Partial word matches are excluded
- The search is case-insensitive
## Limitations
- The `=` operator must be at the very beginning of the search query
- Spaces after `=` will treat it as a regular search
- Multiple `=` operators (like `==example`) are treated as regular text search
## Use Cases
This feature is particularly useful when:
- You know the exact title of a note
- You want to find notes with specific, complete content
- You need to distinguish between notes with similar but not identical titles
- You want to avoid false positives from partial matches
## Related Features
- For more complex exact matching queries, use the full [Search](Search.md) functionality
- For fuzzy matching (finding results despite typos), use the `~=` operator in the full search
- For partial matches with wildcards, use operators like `*=*`, `=*`, or `*=` in the full search

64
docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Quick search.md vendored
View File

@@ -3,16 +3,16 @@
The _Quick search_ function does a full-text search (that is, it searches through the content of notes and not just the title of a note) and displays the result in an easy-to-access manner. The _Quick search_ function does a full-text search (that is, it searches through the content of notes and not just the title of a note) and displays the result in an easy-to-access manner.
The alternative to the quick search is the <a class="reference-link" href="Search.md">Search</a> function, which opens in a dedicated tab and has support for advanced queries. The alternative to the quick search is the <a class="reference-link" href="Search.md">Search</a> function, which opens in a dedicated tab and has support for advanced queries.
For even faster navigation, it's possible to use <a class="reference-link" href="Jump%20to.md">Jump to Note</a> which will only search through the note titles instead of the content. For even faster navigation, it's possible to use <a class="reference-link" href="Jump%20to.md">Jump to...</a> which will only search through the note titles instead of the content.
## Layout ## Layout
Based on the <a class="reference-link" href="../UI%20Elements/Vertical%20and%20horizontal%20layout.md">Vertical and horizontal layout</a>, the quick search is placed: Based on the <a class="reference-link" href="../UI%20Elements/Vertical%20and%20horizontal%20layout.md">Vertical and horizontal layout</a>, the quick search is placed:
* On the vertical layout, it is displayed right above the <a class="reference-link" href="../UI%20Elements/Note%20Tree.md">Note Tree</a>. * On the vertical layout, it is displayed right above the <a class="reference-link" href="../UI%20Elements/Note%20Tree.md">Note Tree</a>.
* On the horizontal layout, it is displayed in the <a class="reference-link" href="../UI%20Elements/Launch%20Bar.md">Launch Bar</a>, where it can be positioned just like any other icon. * On the horizontal layout, it is displayed in the <a class="reference-link" href="../UI%20Elements/Launch%20Bar.md">Launch Bar</a>, where it can be positioned just like any other icon.
## Search Features ## Search Features
@@ -57,3 +57,57 @@ Quick search uses progressive search:
3. **Infinite scrolling**: Additional results load on scroll 3. **Infinite scrolling**: Additional results load on scroll
4. **Specific terms**: Specific search terms return more focused results 4. **Specific terms**: Specific search terms return more focused results
5. **Match locations**: Bold text indicates where matches occur 5. **Match locations**: Bold text indicates where matches occur
## Quick Search - Exact Match Operator
Quick Search now supports the exact match operator (`=`) at the beginning of your search query. This allows you to search for notes where the title or content exactly matches your search term, rather than just containing it.
### Usage
To use exact match in Quick Search:
1. Start your search query with the `=` operator
2. Follow it immediately with your search term (no space after `=`)
#### Examples
* `=example` - Finds notes with title exactly "example" or content exactly "example"
* `=Project Plan` - Finds notes with title exactly "Project Plan" or content exactly "Project Plan"
* `='hello world'` - Use quotes for multi-word exact matches
#### Comparison with Regular Search
| Query | Behavior |
| --- | --- |
| `example` | Finds all notes containing "example" anywhere in title or content |
| `=example` | Finds only notes where the title equals "example" or content equals "example" exactly |
### Technical Details
When you use the `=` operator:
* The search performs an exact match on note titles
* For note content, it looks for exact matches of the entire content
* Partial word matches are excluded
* The search is case-insensitive
### Limitations
* The `=` operator must be at the very beginning of the search query
* Spaces after `=` will treat it as a regular search
* Multiple `=` operators (like `==example`) are treated as regular text search
### Use Cases
This feature is particularly useful when:
* You know the exact title of a note
* You want to find notes with specific, complete content
* You need to distinguish between notes with similar but not identical titles
* You want to avoid false positives from partial matches
### Related Features
* For more complex exact matching queries, use the full [Search](Search.md) functionality
* For fuzzy matching (finding results despite typos), use the `~=` operator in the full search
* For partial matches with wildcards, use operators like `*=*`, `=*`, or `*=` in the full search

2
docs/User Guide/User Guide/Installation & Setup/Server Installation/1. Installing the server/Using Docker.md vendored
View File

@@ -187,7 +187,7 @@ docker run -d --name trilium -p 8080:8080 --user $(id -u):$(id -g) -v ~/trilium-
* `TRILIUM_GID`: GID to use for the container process (passed to Docker's `--user` flag) * `TRILIUM_GID`: GID to use for the container process (passed to Docker's `--user` flag)
* `TRILIUM_DATA_DIR`: Path to the data directory inside the container (default: `/home/node/trilium-data`) * `TRILIUM_DATA_DIR`: Path to the data directory inside the container (default: `/home/node/trilium-data`)
For a complete list of configuration environment variables (network settings, authentication, sync, etc.), see <a class="reference-link" href="../../Advanced%20Usage/Configuration%20(config.ini%20or%20e.md">Configuration (config.ini or environment variables)</a>. For a complete list of configuration environment variables (network settings, authentication, sync, etc.), see <a class="reference-link" href="#root/dmi3wz9muS2O">Configuration (config.ini or environment variables)</a>.
### Volume Permissions ### Volume Permissions

9
docs/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.md vendored
View File

@@ -38,8 +38,8 @@ In order to setup OpenID, you will need to setup a authentication provider. This
1. Set the `oauthBaseUrl`, `oauthClientId` and `oauthClientSecret` in the `config.ini` file (check <a class="reference-link" href="../../Advanced%20Usage/Configuration%20(config.ini%20or%20e.md">Configuration (config.ini or environment variables)</a> for more information). 1. Set the `oauthBaseUrl`, `oauthClientId` and `oauthClientSecret` in the `config.ini` file (check <a class="reference-link" href="../../Advanced%20Usage/Configuration%20(config.ini%20or%20e.md">Configuration (config.ini or environment variables)</a> for more information).
1. You can also setup through environment variables: 1. You can also setup through environment variables:
- Standard: `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL`, `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID`, `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET` * Standard: `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHBASEURL`, `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTID`, `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHCLIENTSECRET`
- Legacy (still supported): `TRILIUM_OAUTH_BASE_URL`, `TRILIUM_OAUTH_CLIENT_ID`, `TRILIUM_OAUTH_CLIENT_SECRET` * Legacy (still supported): `TRILIUM_OAUTH_BASE_URL`, `TRILIUM_OAUTH_CLIENT_ID`, `TRILIUM_OAUTH_CLIENT_SECRET`
2. `oauthBaseUrl` should be the link of your Trilium instance server, for example, `https://<your-trilium-domain>`. 2. `oauthBaseUrl` should be the link of your Trilium instance server, for example, `https://<your-trilium-domain>`.
2. Restart the server 2. Restart the server
3. Go to "Menu" -> "Options" -> "MFA" 3. Go to "Menu" -> "Options" -> "MFA"
@@ -49,8 +49,9 @@ In order to setup OpenID, you will need to setup a authentication provider. This
> [!NOTE] > [!NOTE]
> The default OAuth issuer is Google. To use other services such as Authentik or Auth0, you can configure the settings via `oauthIssuerBaseUrl`, `oauthIssuerName`, and `oauthIssuerIcon` in the `config.ini` file. Alternatively, these values can be set using environment variables: > The default OAuth issuer is Google. To use other services such as Authentik or Auth0, you can configure the settings via `oauthIssuerBaseUrl`, `oauthIssuerName`, and `oauthIssuerIcon` in the `config.ini` file. Alternatively, these values can be set using environment variables:
> - Standard: `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL`, `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME`, `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON` >
> - Legacy (still supported): `TRILIUM_OAUTH_ISSUER_BASE_URL`, `TRILIUM_OAUTH_ISSUER_NAME`, `TRILIUM_OAUTH_ISSUER_ICON` > * Standard: `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERBASEURL`, `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERNAME`, `TRILIUM_MULTIFACTORAUTHENTICATION_OAUTHISSUERICON`
> * Legacy (still supported): `TRILIUM_OAUTH_ISSUER_BASE_URL`, `TRILIUM_OAUTH_ISSUER_NAME`, `TRILIUM_OAUTH_ISSUER_ICON`
> >
> `oauthIssuerName` and `oauthIssuerIcon` are required for displaying correct issuer information at the Login page. > `oauthIssuerName` and `oauthIssuerIcon` are required for displaying correct issuer information at the Login page.

2
docs/User Guide/User Guide/Installation & Setup/Server Installation/TLS Configuration.md vendored
View File

@@ -27,7 +27,7 @@ keyPath=/[username]/.acme.sh/[hostname]/example.com.key
You can also review the [configuration](../../Advanced%20Usage/Configuration%20\(config.ini%20or%20e.md) file to provide all `config.ini` values as environment variables instead. For example, you can configure TLS using environment variables: You can also review the [configuration](../../Advanced%20Usage/Configuration%20\(config.ini%20or%20e.md) file to provide all `config.ini` values as environment variables instead. For example, you can configure TLS using environment variables:
```bash ```sh
export TRILIUM_NETWORK_HTTPS=true export TRILIUM_NETWORK_HTTPS=true
export TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem export TRILIUM_NETWORK_CERTPATH=/path/to/cert.pem
export TRILIUM_NETWORK_KEYPATH=/path/to/key.pem export TRILIUM_NETWORK_KEYPATH=/path/to/key.pem