gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-10-31 03:29:02 +01:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

docs(user): document all share theme attributes

Browse Source
This commit is contained in:
Elian Doran 2025-10-30 15:46:13 +02:00
parent 99f43e2280
commit dd8a1e8aca
No known key found for this signature in database
13 changed files with 711 additions and 479 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json generated vendored
View File

File diff suppressed because one or more lines are too long

11
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Note Map (Link map, Tree map).html generated vendored
View File

@ -6,7 +6,16 @@
<li>Note Map, which shows the hierarchical tree structure.</li> <li>Note Map, which shows the hierarchical tree structure.</li>
</ul> </ul>
<h2>Link Map</h2> <h2>Link Map</h2>
<p>Shows <a href="#root/_help_zEY4DaJG4YT5">relations</a> between notes:</p> <p>The Link map is a visualization of links and&nbsp;<a class="reference-link"
href="#root/_help_Cq5X6iKQop6R">Relations</a>&nbsp;incoming to and outgoing from
a particular note.</p>
<p>The map indicates the following types of relations:</p>
<ul>
<li><a class="reference-link" href="#root/_help_hrZ1D00cLbal">Internal (reference) links</a>&nbsp;between
notes.</li>
<li><a class="reference-link" href="#root/_help_Cq5X6iKQop6R">Relations</a>
</li>
</ul>
<p> <p>
<img src="1_Note Map (Link map, Tree m.png"> <img src="1_Note Map (Link map, Tree m.png">
</p> </p>

635
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing.html generated vendored
View File

@ -6,173 +6,178 @@ class="image">
<img style="aspect-ratio:1144/660;" src="Sharing_image.png" <img style="aspect-ratio:1144/660;" src="Sharing_image.png"
width="1144" height="660"> width="1144" height="660">
</figure> </figure>
<h2>Features, interaction and limitations</h2>
<h2>Features, interaction and limitations</h2>
<ul> <ul>
<li>Searching by note title.</li> <li data-list-item-id="ef22b391cbc76ef956be01dd41a6b60bf">Searching by note title.</li>
<li>Automatic dark/light mode based on the user's browser settings.</li> <li data-list-item-id="eeab18d3a35263669809a1b89d7b060b9">Automatic dark/light mode based on the user's browser settings.</li>
<li>Mobile-friendly layout, with sidebar.</li> <li
<li>Collapsible tree with the same note icons as the application.</li> data-list-item-id="e9a0db9cceacd026e71ad8bda9948542e">Mobile-friendly layout, with sidebar.</li>
<li>Customizable logo.</li> <li data-list-item-id="eb9da2104d017644f71fcee18eb17d34b">Collapsible tree with the same note icons as the application.</li>
<li>Toggle button for dark/light mode, which also stores the user preferences.</li> <li
<li>Quick navigation buttons (previous and next note).</li> data-list-item-id="ea2be5ec72816441e702ff6dba92ed30d">Customizable logo.</li>
<li>Displaying the date of the last update of the note.</li> <li data-list-item-id="e26648726ce48aa84a8c71cf0fe3e4ee2">Toggle button for dark/light mode, which also stores the user preferences.</li>
<li
data-list-item-id="ef143555e0d67d1d389f6bbc226ebdc55">Quick navigation buttons (previous and next note).</li>
<li data-list-item-id="e32f67105cfb655c235d2454d9ec4874f">Displaying the date of the last update of the note.</li>
</ul> </ul>
<h3>By note type</h3> <h3>By note type</h3>
<table class="ck-table-resized"> <figure class="table">
<colgroup> <table class="ck-table-resized">
<col style="width:19.92%;"> <colgroup>
<col style="width:41.66%;"> <col style="width:19.92%;">
<col style="width:38.42%;"> <col style="width:41.66%;">
</colgroup> <col style="width:38.42%;">
<thead> </colgroup>
<tr> <thead>
<th>&nbsp;</th> <tr>
<th>Supported features</th> <th>&nbsp;</th>
<th>Limitations</th> <th>Supported features</th>
</tr> <th>Limitations</th>
</thead> </tr>
<tbody> </thead>
<tr> <tbody>
<th><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_iPIMuisry3hd">Text</a>
<td> </th>
<ul> <td>
<li data-list-item-id="e26b4ce9ba4e9dfe224d04e0f341925ed">Table of contents.</li> <ul>
<li data-list-item-id="e9707fdfa2c92d66690cf932f7e647253">Syntax highlight of code blocks, provided a language is selected (does <li data-list-item-id="e26b4ce9ba4e9dfe224d04e0f341925ed">Table of contents.</li>
not work if “Auto-detected” is enabled).</li> <li data-list-item-id="e9707fdfa2c92d66690cf932f7e647253">Syntax highlight of code blocks, provided a language is selected (does
<li data-list-item-id="e84420a10c6d64bd107edb6e867c91d4b">Rendering for math equations.</li> not work if “Auto-detected” is enabled).</li>
<li data-list-item-id="e10834dcd0619d77ae2e94d3695bedf58"><a href="#root/_help_nBAXQFj20hS1">Including notes</a> (only if the included <li data-list-item-id="e84420a10c6d64bd107edb6e867c91d4b">Rendering for math equations.</li>
notes are also shared).</li> <li data-list-item-id="e10834dcd0619d77ae2e94d3695bedf58"><a href="#root/_help_nBAXQFj20hS1">Including notes</a> (only if the included
</ul> notes are also shared).</li>
</td> </ul>
<td> </td>
<ul> <td>
<li data-list-item-id="e41cc4139377f9f88d653d1eb8ca47bb4">Inline Mermaid diagrams are not rendered.</li> <ul>
</ul> <li data-list-item-id="e41cc4139377f9f88d653d1eb8ca47bb4">Inline Mermaid diagrams are not rendered.</li>
</td> </ul>
</tr> </td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_6f9hih2hXXZk">Code</a>
<td> </th>
<ul> <td>
<li data-list-item-id="e291ae6d5130677b4c99f7c3bdbe974b4">Basic support (displaying the contents of the note in a monospace font).</li> <ul>
</ul> <li data-list-item-id="e291ae6d5130677b4c99f7c3bdbe974b4">Basic support (displaying the contents of the note in a monospace font).</li>
</td> </ul>
<td> </td>
<ul> <td>
<li data-list-item-id="e0270680bbdd7a129306e61e11691e36d">No syntax highlight.</li> <ul>
</ul> <li data-list-item-id="e0270680bbdd7a129306e61e11691e36d">No syntax highlight.</li>
</td> </ul>
</tr> </td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_m523cpzocqaD">Saved Search</a>
<td>Not supported.</td> </th>
<td>&nbsp;</td> <td>Not supported.</td>
</tr> <td>&nbsp;</td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_iRwzGnHPzonm">Relation Map</a>
<td>Not supported.</td> </th>
<td>&nbsp;</td> <td>Not supported.</td>
</tr> <td>&nbsp;</td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_bdUJEHsAPYQR">Note Map</a>
<td>Not supported.</td> </th>
<td>&nbsp;</td> <td>Not supported.</td>
</tr> <td>&nbsp;</td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_HcABDtFCkbFN">Render Note</a>
<td>Not supported.</td> </th>
<td>&nbsp;</td> <td>Not supported.</td>
</tr> <td>&nbsp;</td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_GTwFsgaA0lCt">Collections</a>
<td> </th>
<ul> <td>
<li data-list-item-id="ea031e1d4149eb443ace756234490c5a4">The child notes are displayed in a fixed format.&nbsp;</li> <ul>
</ul> <li data-list-item-id="ea031e1d4149eb443ace756234490c5a4">The child notes are displayed in a fixed format.&nbsp;</li>
</td> </ul>
<td> </td>
<ul> <td>
<li data-list-item-id="ea4a9d424aec2afbaecc07bbf64b7bebd">More advanced view types such as the calendar view are not supported.</li> <ul>
</ul> <li data-list-item-id="ea4a9d424aec2afbaecc07bbf64b7bebd">More advanced view types such as the calendar view are not supported.</li>
</td> </ul>
</tr> </td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_s1aBHPd79XYj">Mermaid Diagrams</a>
<td> </th>
<ul> <td>
<li data-list-item-id="e582d283f2b1b30cbe5ae35d8e01b2bf2">The diagram is displayed as a vector image.</li> <ul>
</ul> <li data-list-item-id="e582d283f2b1b30cbe5ae35d8e01b2bf2">The diagram is displayed as a vector image.</li>
</td> </ul>
<td> </td>
<ul> <td>
<li data-list-item-id="e33268686446e3c217077201bb5964364">No further interaction supported.</li> <ul>
</ul> <li data-list-item-id="e33268686446e3c217077201bb5964364">No further interaction supported.</li>
</td> </ul>
</tr> </td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_grjYqerjn243">Canvas</a>
<td> </th>
<ul> <td>
<li data-list-item-id="e443dd0e97c30cb12c77e8906a71569ea">The diagram is displayed as a vector image.</li> <ul>
</ul> <li data-list-item-id="e443dd0e97c30cb12c77e8906a71569ea">The diagram is displayed as a vector image.</li>
</td> </ul>
<td> </td>
<ul> <td>
<li data-list-item-id="efe151ef3f3826c825416417525fb5fb2">No further interaction supported.</li> <ul>
</ul> <li data-list-item-id="efe151ef3f3826c825416417525fb5fb2">No further interaction supported.</li>
</td> </ul>
</tr> </td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_1vHRoWCEjj0L">Web View</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_1vHRoWCEjj0L">Web View</a>
<td>Not supported.</td> </th>
<td>&nbsp;</td> <td>Not supported.</td>
</tr> <td>&nbsp;</td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_gBbsAeiuUxI5">Mind Map</a>
<td>The diagram is displayed as a vector image.</td> </th>
<td> <td>The diagram is displayed as a vector image.</td>
<ul> <td>
<li data-list-item-id="ed3b4fb473042f6e32b4502d4fa11a767">No further interaction supported.</li> <ul>
</ul> <li data-list-item-id="ed3b4fb473042f6e32b4502d4fa11a767">No further interaction supported.</li>
</td> </ul>
</tr> </td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map View</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_81SGnPGMk7Xc">Geo Map</a>
<td>Not supported.</td> </th>
<td>&nbsp;</td> <td>Not supported.</td>
</tr> <td>&nbsp;</td>
<tr> </tr>
<th><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a> <tr>
</th> <th><a class="reference-link" href="#root/_help_W8vYD3Q1zjCR">File</a>
<td>Basic interaction (downloading the file).</td> </th>
<td> <td>Basic interaction (downloading the file).</td>
<ul> <td>
<li data-list-item-id="ed87e836a39d127ebcbb33e9e59045afb">No further interaction supported.</li> <ul>
</ul> <li data-list-item-id="ed87e836a39d127ebcbb33e9e59045afb">No further interaction supported.</li>
</td> </ul>
</tr> </td>
</tbody> </tr>
</table> </tbody>
</table>
</figure>
<p>While the sharing feature is powerful, it has some limitations:</p> <p>While the sharing feature is powerful, it has some limitations:</p>
<ul> <ul>
<li><strong>Code Notes</strong>: No syntax highlighting.</li> <li data-list-item-id="e35e0cab1eec05f391623e8279959070c"><strong>Code Notes</strong>: No syntax highlighting.</li>
<li><strong>Static Note Tree</strong> <li class="ck-list-marker-bold"
data-list-item-id="e36b70bd10c3666c0def874b4ec52db31"><strong>Static Note Tree</strong>
</li> </li>
<li><strong>Protected Notes</strong>: Cannot be shared.</li> <li data-list-item-id="ef8144aff172d450cf7b4edbf1a430ab9"><strong>Protected Notes</strong>: Cannot be shared.</li>
<li><strong>Include Notes</strong>: Not supported.</li> <li data-list-item-id="ec3761c9dce911b115b840a32eebd18b8"><strong>Include Notes</strong>: Not supported.</li>
</ul> </ul>
<p>Some of these limitations may be addressed in future updates.</p> <p>Some of these limitations may be addressed in future updates.</p>
<h2>Prerequisites</h2> <h2>Prerequisites</h2>
@ -181,7 +186,7 @@ class="image">
is necessary because the notes will be hosted from the server.</p> is necessary because the notes will be hosted from the server.</p>
<h2>Sharing a note</h2> <h2>Sharing a note</h2>
<ol> <ol>
<li> <li data-list-item-id="e503f8ad52fe9033ef59212b7b692d69f">
<p><strong>Enable Sharing</strong>: To share a note, toggle the <code>Shared</code> switch <p><strong>Enable Sharing</strong>: To share a note, toggle the <code>Shared</code> switch
within the note's interface. Once sharing is enabled, an URL will appear, within the note's interface. Once sharing is enabled, an URL will appear,
which you can click to access the shared note.</p> which you can click to access the shared note.</p>
@ -190,11 +195,9 @@ class="image">
alt="Share Note"> alt="Share Note">
</p> </p>
</li> </li>
<li> <li data-list-item-id="e9c5083764d919503412f4f7f1cb0e0e0"><strong>Access the Shared Note</strong>: The link provided will open the
<p><strong>Access the Shared Note</strong>: The link provided will open the note in your browser. If your server is not configured with a public IP,
note in your browser. If your server is not configured with a public IP, the URL will refer to <code>localhost (127.0.0.1)</code>.</li>
the URL will refer to <code>localhost (127.0.0.1)</code>.</p>
</li>
</ol> </ol>
<h2>Sharing a note subtree</h2> <h2>Sharing a note subtree</h2>
<p>When you share a note, you actually share the entire subtree of notes <p>When you share a note, you actually share the entire subtree of notes
@ -208,9 +211,19 @@ class="image">
This allows you to manage and navigate through all the notes you have made This allows you to manage and navigate through all the notes you have made
public.</p> public.</p>
<h2>Security considerations</h2> <h2>Security considerations</h2>
<p>Shared notes are published on the open internet and can be accessed by <ul>
anyone with the URL. The URL's randomness does not provide security, so <li data-list-item-id="ea35f4596f6a8c69a83416766b567c3cd">Shared notes are published on the open internet and can be accessed by
it is crucial not to share sensitive information through this feature.</p> anyone with the URL unless the notes are password-protected.</li>
<li data-list-item-id="e34e983d07439b781597d1abaf8b6e297">The URL's randomness does not provide security, so it is crucial not to
share sensitive information through this feature.</li>
<li data-list-item-id="e94fbe4fb4b9f7806074aba4fe7601cb7">Trilium takes precautions to protect your publicly shared instance from
leaking information for non-shared notes, including opening a separate
read-only connection to the&nbsp;<a class="reference-link" href="#root/_help_wX4HbRucYSDD">Database</a>.
Depending on your threat model, it might make more sense to use&nbsp;
<a
class="reference-link" href="#root/_help_ycBFjKrrwE9p">Exporting HTML for web publishing</a>&nbsp;and use battle-tested web servers
such as Nginx or Apache to serve static content.</li>
</ul>
<h3>Password protection</h3> <h3>Password protection</h3>
<p>To protect shared notes with a username and password, you can use the <code>#shareCredentials</code> attribute. <p>To protect shared notes with a username and password, you can use the <code>#shareCredentials</code> attribute.
Add this label to the note with the format <code>#shareCredentials="username:password"</code>. Add this label to the note with the format <code>#shareCredentials="username:password"</code>.
@ -220,12 +233,13 @@ class="image">
<p>The default design should be a good starting point, but you can customize <p>The default design should be a good starting point, but you can customize
it using your own CSS:</p> it using your own CSS:</p>
<ul> <ul>
<li><strong>Custom CSS</strong>: Link a CSS&nbsp;<a class="reference-link" <li data-list-item-id="e3fdd3f9d73ed0655a94330d0a75790e4"><strong>Custom CSS</strong>: Link a CSS&nbsp;<a class="reference-link"
href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;note to the shared page by adding href="#root/_help_6f9hih2hXXZk">Code</a>&nbsp;note to the shared page by adding
a <code>~shareCss</code> relation to the note. If you want this style to a <code>~shareCss</code> relation to the note. If you want this style to
apply to the entire subtree, make the label inheritable. You can hide the apply to the entire subtree, make the label inheritable. You can hide the
CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li> CSS code note from the tree navigation by adding the <code>#shareHiddenFromTree</code> label.</li>
<li><strong>Omitting Default CSS</strong>: For extensive styling changes, <li
data-list-item-id="ee0bb81c27f4cd176412d38258d32da39"><strong>Omitting Default CSS</strong>: For extensive styling changes,
use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's use the <code>#shareOmitDefaultCss</code> label to avoid conflicts with Trilium's
<a <a
href="#root/_help_Wy267RK4M69c">default stylesheet</a>.</li> href="#root/_help_Wy267RK4M69c">default stylesheet</a>.</li>
@ -243,22 +257,22 @@ class="image">
itself.</p> itself.</p>
<p>The <code>#shareHtmlLocation</code> label accepts values in the format <code>location:position</code>:</p> <p>The <code>#shareHtmlLocation</code> label accepts values in the format <code>location:position</code>:</p>
<ul> <ul>
<li><strong>Locations</strong>: <code>head</code>, <code>body</code>, <code>content</code> <li data-list-item-id="ead2588d20ac1fb23e7cb2a6d33d02bcb"><strong>Locations</strong>: <code>head</code>, <code>body</code>, <code>content</code>
</li> </li>
<li><strong>Positions</strong>: <code>start</code>, <code>end</code> <li data-list-item-id="e368323f330b229cb3428266304ebc2b4"><strong>Positions</strong>: <code>start</code>, <code>end</code>
</li> </li>
</ul> </ul>
<p>For example:</p> <p>For example:</p>
<ul> <ul>
<li><code>#shareHtmlLocation=head:start</code> - Injects HTML at the beginning <li data-list-item-id="e2f0cbb70e71902ec26d64b4c10f1b3cf"><code>#shareHtmlLocation=head:start</code> - Injects HTML at the beginning
of the <code>&lt;head&gt;</code> section</li> of the <code>&lt;head&gt;</code> section</li>
<li><code>#shareHtmlLocation=head:end</code> - Injects HTML at the end of the <code>&lt;head&gt;</code> section <li data-list-item-id="e2ac6f7ec36059fc5ea2148bee57d9329"><code>#shareHtmlLocation=head:end</code> - Injects HTML at the end of the <code>&lt;head&gt;</code> section
(default)</li> (default)</li>
<li><code>#shareHtmlLocation=body:start</code> - Injects HTML at the beginning <li data-list-item-id="e9fea05a82b09b66521807ae4b08bfd53"><code>#shareHtmlLocation=body:start</code> - Injects HTML at the beginning
of the <code>&lt;body&gt;</code> section</li> of the <code>&lt;body&gt;</code> section</li>
<li><code>#shareHtmlLocation=content:start</code> - Injects HTML at the beginning <li data-list-item-id="ed33846c38d6e8a631111fc858ecf4963"><code>#shareHtmlLocation=content:start</code> - Injects HTML at the beginning
of the content area</li> of the content area</li>
<li><code>#shareHtmlLocation=content:end</code> - Injects HTML at the end of <li data-list-item-id="e89347723de7736060ce226d93530a162"><code>#shareHtmlLocation=content:end</code> - Injects HTML at the end of
the content area</li> the content area</li>
</ul> </ul>
<p>If no location is specified, the HTML will be injected at <code>content:end</code> by <p>If no location is specified, the HTML will be injected at <code>content:end</code> by
@ -276,16 +290,16 @@ for (const attr of parentNote.attributes) {
This will change the URL to <code>http://domain.tld/share/highlighting</code>.</p> This will change the URL to <code>http://domain.tld/share/highlighting</code>.</p>
<p><strong>Important</strong>:</p> <p><strong>Important</strong>:</p>
<ol> <ol>
<li>Ensure that aliases are unique.</li> <li data-list-item-id="edff04cba1df31a2aae23fd2f6a5ee847">Ensure that aliases are unique.</li>
<li>Using slashes (<code>/</code>) within aliases to create subpaths is not <li data-list-item-id="eea48bfb287b0559450050141243032a9">Using slashes (<code>/</code>) within aliases to create subpaths is not
supported.</li> supported.</li>
</ol> </ol>
<aside class="admonition tip"> <aside class="admonition tip">
<ul> <ul>
<li>To easily identify pages that don't have a share alias, run a&nbsp; <li data-list-item-id="e0fcb644d56cb60448a87ddb7831e6043">To easily identify pages that don't have a share alias, run a&nbsp;
<a <a
class="reference-link" href="#root/_help_eIg8jdvaoNNd">Search</a>&nbsp;with <code>#!shareAlias</code>.</li> class="reference-link" href="#root/_help_eIg8jdvaoNNd">Search</a>&nbsp;with <code>#!shareAlias</code>.</li>
<li>To be able to enter the share alias faster, consider using&nbsp;<a class="reference-link" <li data-list-item-id="e888d6e9d905db9a030755430007e522b">To be able to enter the share alias faster, consider using&nbsp;<a class="reference-link"
href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;(for example <code>#label:shareAlias(inheritable)="promoted,alias=Slug,single,text"</code>).</li> href="#root/_help_OFXdgB2nNk1F">Promoted Attributes</a>&nbsp;(for example <code>#label:shareAlias(inheritable)="promoted,alias=Slug,single,text"</code>).</li>
</ul> </ul>
</aside> </aside>
@ -309,91 +323,176 @@ for (const attr of parentNote.attributes) {
When viewed, the list of shared roots will be displayed at the bottom of When viewed, the list of shared roots will be displayed at the bottom of
the note.</p> the note.</p>
<h2>Attribute reference</h2> <h2>Attribute reference</h2>
<table> <figure class="table" style="width:100%;">
<thead> <table class="ck-table-resized">
<tr> <colgroup>
<th>Attribute</th> <col style="width:18.38%;">
<th>Description</th> <col style="width:81.62%;">
</tr> </colgroup>
</thead> <thead>
<tbody> <tr>
<tr> <th>Attribute</th>
<td><code>shareHiddenFromTree</code> <th>Description</th>
</td> </tr>
<td>this note is hidden from left navigation tree, but still accessible with </thead>
its URL</td> <tbody>
</tr> <tr>
<tr> <td><code>#shareHiddenFromTree</code>
<td><code>shareExternalLink</code> </td>
</td> <td>this note is hidden from left navigation tree, but still accessible with
<td>note will act as a link to an external website in the share tree</td> its URL</td>
</tr> </tr>
<tr> <tr>
<td><code>shareAlias</code> <td><code>#shareExternalLink</code>
</td> </td>
<td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code> <td>note will act as a link to an external website in the share tree</td>
</td> </tr>
</tr> <tr>
<tr> <td><code>#shareAlias</code>
<td><code>shareOmitDefaultCss</code> </td>
</td> <td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code>
<td>default share page CSS will be omitted. Use when you make extensive styling </td>
changes.</td> </tr>
</tr> <tr>
<tr> <td><code>#shareOmitDefaultCss</code>
<td><code>shareRoot</code> </td>
</td> <td>default share page CSS will be omitted. Use when you make extensive styling
<td>marks note which is served on /share root.</td> changes.</td>
</tr> </tr>
<tr> <tr>
<td><code>shareDescription</code> <td><code>#shareRoot</code>
</td> </td>
<td>define text to be added to the HTML meta tag for description</td> <td>marks note which is served on /share root.</td>
</tr> </tr>
<tr> <tr>
<td><code>shareRaw</code> <td><code>#shareDescription</code>
</td> </td>
<td>Note will be served in its raw format, without HTML wrapper. See also&nbsp; <td>define text to be added to the HTML meta tag for description</td>
<a </tr>
class="reference-link" href="#root/_help_Qjt68inQ2bRj">Serving directly the content of a note</a>&nbsp;for an alternative method <tr>
without setting an attribute.</td> <td><code>#shareRaw</code>
</tr> </td>
<tr> <td>Note will be served in its raw format, without HTML wrapper. See also&nbsp;
<td><code>shareDisallowRobotIndexing</code> <a
</td> class="reference-link" href="#root/_help_Qjt68inQ2bRj">Serving directly the content of a note</a>&nbsp;for an alternative method
<td> without setting an attribute.</td>
<p>Indicates to web crawlers that the page should not be indexed of this </tr>
note by:</p> <tr>
<ul> <td><code>#shareDisallowRobotIndexing</code>
<li data-list-item-id="e6baa9f60bf59d085fd31aa2cce07a0e7">Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li> </td>
<li data-list-item-id="ec0d067db136ef9794e4f1033405880b7">Setting the <code>noindex, follow</code> meta tag.</li> <td>
</ul> <p>Indicates to web crawlers that the page should not be indexed of this
</td> note by:</p>
</tr> <ul>
<tr> <li data-list-item-id="e6baa9f60bf59d085fd31aa2cce07a0e7">Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li>
<td><code>shareCredentials</code> <li data-list-item-id="ec0d067db136ef9794e4f1033405880b7">Setting the <code>noindex, follow</code> meta tag.</li>
</td> </ul>
<td>require credentials to access this shared note. Value is expected to be </td>
in format <code>username:password</code>. Don't forget to make this inheritable </tr>
to apply to child-notes/images.</td> <tr>
</tr> <td><code>#shareCredentials</code>
<tr> </td>
<td><code>shareIndex</code> <td>require credentials to access this shared note. Value is expected to be
</td> in format <code>username:password</code>. Don't forget to make this inheritable
<td>Note with this label will list all roots of shared notes.</td> to apply to child-notes/images.</td>
</tr> </tr>
<tr> <tr>
<td><code>shareHtmlLocation</code> <td><code>#shareIndex</code>
</td> </td>
<td>defines where custom HTML injected via <code>~shareHtml</code> relation <td>Note with this label will list all roots of shared notes.</td>
should be placed. Applied to the HTML snippet note itself. Format: <code>location:position</code> where </tr>
location is <code>head</code>, <code>body</code>, or <code>content</code> and <tr>
position is <code>start</code> or <code>end</code>. Defaults to <code>content:end</code>.</td> <td><code>#shareHtmlLocation</code>
</tr> </td>
</tbody> <td>defines where custom HTML injected via <code>~shareHtml</code> relation
</table> should be placed. Applied to the HTML snippet note itself. Format: <code>location:position</code> where
location is <code>head</code>, <code>body</code>, or <code>content</code> and
<h2>Credits</h2> position is <code>start</code> or <code>end</code>. Defaults to <code>content:end</code>.</td>
</tr>
</tbody>
</table>
</figure>
<h3>Customizing logo</h3>
<p>It's possible to adjust the logo which is displayed on the top-left of
the left pane.</p>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:19.08%;">
<col style="width:80.92%;">
</colgroup>
<thead>
<tr>
<th>Attribute</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>~shareLogo</code>
</td>
<td>Relation set to an image to use as logo. The image must be part of the
share tree (it can be hidden if needed).</td>
</tr>
<tr>
<td><code>#shareLogoWidth</code>
</td>
<td>The width (in pixels, without unit) to set for the logo. Default is <code>53</code>.</td>
</tr>
<tr>
<td><code>#shareLogoHeight</code>
</td>
<td>The height (in pixels, without unit) to set for the logo. Default is <code>40</code>.</td>
</tr>
<tr>
<td><code>#shareRootLink</code>
</td>
<td>URL to navigate to when the logo is pressed.</td>
</tr>
</tbody>
</table>
</figure>
<h3>Customizing OpenGraph</h3>
<figure class="table" style="width:100%;">
<table class="ck-table-resized">
<colgroup>
<col style="width:19.08%;">
<col style="width:80.92%;">
</colgroup>
<thead>
<tr>
<th>Attribute</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span style="color:#3b3b3b;"><code>#shareOpenGraphColor</code></span>
</td>
<td>This adjusts the <code>theme-color</code> meta-property.</td>
</tr>
<tr>
<td><code>#shareOpenGraphURL</code>
</td>
<td>This adjusts the <code>og:url</code> and <code>twitter:url</code> meta-properties.</td>
</tr>
<tr>
<td><code>#shareOpenGraphDomain</code>
</td>
<td>Adjusts the <code>twitter:domain</code> meta-property.</td>
</tr>
<tr>
<td><code>#shareOpenGraphImage</code>
<br><code>~shareOpenGraphImage</code>
</td>
<td>Can be either a label, case in which the value is passed on as-is, or
it can be a relation to an image&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/_help_W8vYD3Q1zjCR">File</a>.
This controls the <code>og:image</code> meta-property.</td>
</tr>
</tbody>
</table>
</figure>
<h2>Credits</h2>
<p>Since v0.95.0, a new theme was introduced (and enabled by default) which <p>Since v0.95.0, a new theme was introduced (and enabled by default) which
greatly improves the visual aspect of the Share feature, as well as its greatly improves the visual aspect of the Share feature, as well as its
functionality (such as mobile support, dark/light mode, collapsible tree, functionality (such as mobile support, dark/light mode, collapsible tree,

7
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Exporting HTML for web publish.html generated vendored
View File

@ -20,7 +20,7 @@
importing the Markdown documentation and exporting it via a script to the importing the Markdown documentation and exporting it via a script to the
static web format.</p> static web format.</p>
</aside> </aside>
<h2>Differences from normal sharing and export</h2> <h2>Differences from normal sharing</h2>
<p>Apart from normal&nbsp;<a class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>, <p>Apart from normal&nbsp;<a class="reference-link" href="#root/_help_R9pX4DGra2Vt">Sharing</a>,
exporting to static HTML files comes with a few subtle differences:</p> exporting to static HTML files comes with a few subtle differences:</p>
<ul> <ul>
@ -52,4 +52,7 @@
<li>Extract the exported .zip file.</li> <li>Extract the exported .zip file.</li>
<li>Inside the extracted directory, run <code>http-server</code>.</li> <li>Inside the extracted directory, run <code>http-server</code>.</li>
<li>Access the indicated address (e.g. <a href="http://localhost:8080">http://localhost:8080</a>).</li> <li>Access the indicated address (e.g. <a href="http://localhost:8080">http://localhost:8080</a>).</li>
</ol> </ol>
<h2>Automation</h2>
<p><a class="reference-link" href="#root/_help_pgxEVkzLl1OP">ETAPI (REST API)</a>&nbsp;could
potentially be used to automate an export on a scheduled task.</p>

23
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Advanced Usage/Sharing/Reverse proxy configuration.html generated vendored Normal file
View File

@ -0,0 +1,23 @@
<p>It might be desirable to only expose the share functionality of Trilium
to the Internet, and keep the application accessible only within a local
network or via VPN.</p>
<p>To do so, a reverse proxy is required.</p>
<h2>Caddy</h2><pre><code class="language-text-x-trilium-auto">http://domain.com {
reverse_proxy /share http://localhost:8080/share
}</code></pre>
<p>This is for newer versions where the share functionality is isolated,
for older versions it's required to also include <code>/assets</code>.
<span
class="footnote-reference" data-footnote-reference="" data-footnote-index="1"
data-footnote-id="2b8mg20aol8" role="doc-noteref" id="fnref2b8mg20aol8"><sup><a href="#fn2b8mg20aol8">[1]</a></sup>
</span>
</p>
<ol class="footnote-section footnotes" data-footnote-section="" role="doc-endnotes">
<li class="footnote-item" data-footnote-item="" data-footnote-index="1"
data-footnote-id="2b8mg20aol8" role="doc-endnote" id="fn2b8mg20aol8"><span class="footnote-back-link" data-footnote-back-link="" data-footnote-id="2b8mg20aol8"><sup><strong><a href="#fnref2b8mg20aol8">^</a></strong></sup></span>
<div
class="footnote-content" data-footnote-content="">
<p><a href="https://github.com/orgs/TriliumNext/discussions/7341#discussioncomment-14679897">https://github.com/orgs/TriliumNext/discussions/7341#discussioncomment-14679897</a>&nbsp;</p>
</div>
</li>
</ol>

31
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/Import & Export.html generated vendored
View File

@ -1,31 +1,30 @@
<p>Trilium natively supports the following formats for both import and export.</p> <p>Trilium natively supports the following formats for both import and export.</p>
<ul> <ul>
<li data-list-item-id="ecbfc881c66732c02aa6e7d726644d8bf">HTML: <li>HTML:
<ul> <ul>
<li data-list-item-id="eb869f70d49a6f5754fd7c0ea12d41e4d">This is the main format used by Trilium, where standard tags are used <li>This is the main format used by Trilium, where standard tags are used
to represent basic formatting and layout (e.g. <code>&lt;strong&gt;</code>, <code>&lt;table&gt;</code>, <code>&lt;pre&gt;</code>).&nbsp;</li> to represent basic formatting and layout (e.g. <code>&lt;strong&gt;</code>, <code>&lt;table&gt;</code>, <code>&lt;pre&gt;</code>).</li>
<li <li>Note that HTML is not a standardized format so some more specific features
data-list-item-id="e34558f623b9aa8cf213a7fdefd434599">Note that HTML is not a standardized format so some more specific features such as admonitions or&nbsp;<a class="reference-link" href="#root/_help_hrZ1D00cLbal">Internal (reference) links</a>&nbsp;might
such as admonitions or&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/KSZ04uQ2D1St/iPIMuisry3hd/QEAPj01N5f7w/_help_hrZ1D00cLbal">Internal (reference) links</a>&nbsp;might
not be supported by other applications.</li> not be supported by other applications.</li>
</ul>
</li>
<li data-list-item-id="e19d9bf03c7721a1213b13d57c538bb3c"><a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/mHbBMPDPkVV5/_help_Oau6X9rCuegd">Markdown</a>
<ul>
<li data-list-item-id="ed987b5652f140018f4ae5021fb22888c">Most of the formatting is preserved, see&nbsp;<a class="reference-link"
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/mHbBMPDPkVV5/Oau6X9rCuegd/_help_rJ9grSgoExl9">Supported syntax</a>.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="e9a2bcf3fa8a4b2614df4b61b2023f1cb">OPML (Outliner Interchange Format) <li><a class="reference-link" href="#root/_help_Oau6X9rCuegd">Markdown</a>
<ul> <ul>
<li data-list-item-id="e878699fc9d0bd5cc3b9899ca385cf884">Supports both OPML v1.0 for plain text and v2.0 with HTML support.</li> <li>Most of the formatting is preserved, see&nbsp;<a class="reference-link"
href="#root/_help_rJ9grSgoExl9">Supported syntax</a>.</li>
</ul>
</li>
<li>OPML (Outliner Interchange Format)
<ul>
<li>Supports both OPML v1.0 for plain text and v2.0 with HTML support.</li>
</ul> </ul>
</li> </li>
</ul> </ul>
<p>To import from other applications, see the dedicated pages:</p> <p>To import from other applications, see the dedicated pages:</p>
<ul> <ul>
<li data-list-item-id="e222c10292f253e00d2b79ec0ad16d5a2"><a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/mHbBMPDPkVV5/_help_syuSEKf2rUGr">Evernote</a> <li><a class="reference-link" href="#root/_help_syuSEKf2rUGr">Evernote</a>
</li> </li>
<li data-list-item-id="e348b2a0fec8827945ab6142f306fa5ac"><a class="reference-link" href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/mHbBMPDPkVV5/_help_GnhlmrATVqcH">OneNote</a> <li><a class="reference-link" href="#root/_help_GnhlmrATVqcH">OneNote</a>
</li> </li>
</ul> </ul>

62
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Collections/Kanban Board.html generated vendored
View File

@ -15,73 +15,71 @@
<h2>Interaction</h2> <h2>Interaction</h2>
<h3>Working with columns</h3> <h3>Working with columns</h3>
<ul> <ul>
<li data-list-item-id="e71e07c51ee7b92a0e14558b0919e277f">Create a new column by pressing <em>Add Column</em> near the last column. <li>Create a new column by pressing <em>Add Column</em> near the last column.
<ul> <ul>
<li data-list-item-id="e180693eb6774bde8117de60921b6913a">Once pressed, a text box will be displayed to set the name of the column. <li>Once pressed, a text box will be displayed to set the name of the column.
Press <kbd>Enter</kbd> to confirm, or <kbd>Escape</kbd> to dismiss.</li> Press <kbd>Enter</kbd> to confirm, or <kbd>Escape</kbd> to dismiss.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="e7211ad7dc7cab0687331d14c2b99d03f">To reorder a column, simply hold the mouse over the title and drag it <li>To reorder a column, simply hold the mouse over the title and drag it
to the desired position.</li> to the desired position.</li>
<li data-list-item-id="e4296397b7a543d2b57fa81ad998ae7c1">To delete a column, right click on its title and select <em>Delete column</em>.</li> <li>To delete a column, right click on its title and select <em>Delete column</em>.</li>
<li <li>To rename a column, click on the note title.
data-list-item-id="ee84a4e6786465a68e74553cb152a3846">To rename a column, click on the note title.
<ul> <ul>
<li data-list-item-id="ed32176d3c349122fd7eb5940bdc72304">Press Enter to confirm.</li> <li>Press Enter to confirm.</li>
<li data-list-item-id="e6487ae4a01bfc73f704e1c0b26492646">Upon renaming a column, the corresponding status attribute of all its <li>Upon renaming a column, the corresponding status attribute of all its
notes will be changed in bulk.</li> notes will be changed in bulk.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="e7c1b6716bf8e8c5494af7168ba6b1ed0">If there are many columns, use the mouse wheel to scroll.</li> <li>If there are many columns, use the mouse wheel to scroll.</li>
</ul> </ul>
<h3>Working with notes</h3> <h3>Working with notes</h3>
<ul> <ul>
<li data-list-item-id="e6a35bda3dc02a267b1f79b5b2e08dcfc">Create a new note in any column by pressing <em>New item</em> <li>Create a new note in any column by pressing <em>New item</em>
<ul> <ul>
<li data-list-item-id="ee8597aaafbd5b52757c0d9785313c1c9">Enter the name of the note and press <kbd>Enter</kbd> or click away. To <li>Enter the name of the note and press <kbd>Enter</kbd> or click away. To
dismiss the creation of a new note, simply press <kbd>Escape</kbd> or leave dismiss the creation of a new note, simply press <kbd>Escape</kbd> or leave
the name empty.</li> the name empty.</li>
<li data-list-item-id="e64d710431199d23f5a07328984022c63">Once created, the new note will have an attribute (<code>status</code> label <li>Once created, the new note will have an attribute (<code>status</code> label
by default) set to the name of the column.</li> by default) set to the name of the column.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="e9486f9e0d256a775e133fc63ab0e80e2">To open the note, simply click on it.</li> <li>To open the note, simply click on it.</li>
<li data-list-item-id="efa61e40cfeba0446d4f0e1122675f130">To change the title of the note directly from the board, hover the mouse <li>To change the title of the note directly from the board, hover the mouse
over its card and press the edit button on the right.</li> over its card and press the edit button on the right.</li>
<li data-list-item-id="ef4e4a20b6d3441f716754bc7a57658ff">To change the state of a note, simply drag a note from one column to the <li>To change the state of a note, simply drag a note from one column to the
other to change its state.</li> other to change its state.</li>
<li data-list-item-id="ed8eb85cbc1f2d5fed6f016e4d08e4687">The order of the notes in each column corresponds to their position in <li>The order of the notes in each column corresponds to their position in
the tree. the tree.
<ul> <ul>
<li data-list-item-id="ec1cea6b62dffeb48c44644b131d0b7cd">It's possible to reorder notes simply by dragging them to the desired <li>It's possible to reorder notes simply by dragging them to the desired
position within the same columns.</li> position within the same columns.</li>
<li data-list-item-id="e3e51133b009a978bf89a416b9f0d085c">It's also possible to drag notes across columns, at the desired position.</li> <li>It's also possible to drag notes across columns, at the desired position.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="e86b5125649a0b1660eb09682419cddf9">For more options, right click on a note to display a context menu with <li>For more options, right click on a note to display a context menu with
the following options: the following options:
<ul> <ul>
<li data-list-item-id="efa4ffbceeb4943ca8b705d577555ac64">Open the note in a new tab/split/window or quick edit.</li> <li>Open the note in a new tab/split/window or quick edit.</li>
<li data-list-item-id="e8cee58cebbfde07d324d0abb36f20a89">Move the note to any column.</li> <li>Move the note to any column.</li>
<li data-list-item-id="e6779944c6554afcdc9a808995428051d">Insert a new note above/below the current one.</li> <li>Insert a new note above/below the current one.</li>
<li data-list-item-id="eba0288779c515d5012eb192e0d70a4d1">Archive/unarchive the current note.</li> <li>Archive/unarchive the current note.</li>
<li data-list-item-id="e40d0c84f12d894a6ce516da232bd2d98">Delete the current note.</li> <li>Delete the current note.</li>
</ul> </ul>
</li> </li>
<li data-list-item-id="eed667ebc4861738de6be267828bed695">If there are many notes within the column, move the mouse over the column <li>If there are many notes within the column, move the mouse over the column
and use the mouse wheel to scroll.</li> and use the mouse wheel to scroll.</li>
</ul> </ul>
<h2>Keyboard interaction</h2> <h2>Keyboard interaction</h2>
<p>The board view has mild support for keyboard-based navigation:</p> <p>The board view has mild support for keyboard-based navigation:</p>
<ul> <ul>
<li data-list-item-id="e36106d48098f4876b570d5701391a2b4">Use <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> to navigate between <li>Use <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> to navigate between
column titles, notes and the “New item” button for each of the columns, column titles, notes and the “New item” button for each of the columns,
in sequential order.</li> in sequential order.</li>
<li data-list-item-id="e84c733e130af341c71a0258b4966e81e">To rename a column or a note, press <kbd>F2</kbd> while it is focused.</li> <li>To rename a column or a note, press <kbd>F2</kbd> while it is focused.</li>
<li <li>To open a specific note or create a new item, press <kbd>Enter</kbd> while
data-list-item-id="ed5e255d6854b9e5c5cbe3b9d1c64e87f">To open a specific note or create a new item, press <kbd>Enter</kbd> while
it is focused.</li> it is focused.</li>
<li data-list-item-id="ed74ccf2643ef8c73cc88b34c246c0edf">To dismiss a rename of a note or a column, press <kbd>Escape</kbd>.</li> <li>To dismiss a rename of a note or a column, press <kbd>Escape</kbd>.</li>
</ul> </ul>
<h2>Configuration</h2> <h2>Configuration</h2>
<h3>Grouping by another attribute</h3> <h3>Grouping by another attribute</h3>
@ -95,5 +93,5 @@ class="admonition note">
</aside> </aside>
<h2>Limitations</h2> <h2>Limitations</h2>
<ul> <ul>
<li data-list-item-id="e490b30ca429e17009c72647524964ef0">It is not possible yet to use group by a relation, only by label.</li> <li>It is not possible yet to use group by a relation, only by label.</li>
</ul> </ul>

145
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Data directory.html generated vendored
View File

@ -1,12 +1,12 @@
<p>Data directory contains:</p> <p>Data directory contains:</p>
<ul> <ul>
<li data-list-item-id="e7e3f98ffede29728ab8d5dfd25d8f8a7"><code>document.db</code> - <a href="#root/_help_wX4HbRucYSDD">database</a> <li><code>document.db</code> - <a href="#root/_help_wX4HbRucYSDD">database</a>
</li> </li>
<li data-list-item-id="eb78343d193877e82846fc94581037d9d"><code>config.ini</code> - instance level settings like port on which the <li><code>config.ini</code> - instance level settings like port on which the
Trilium application runs</li> Trilium application runs</li>
<li data-list-item-id="e73061b739634b18f45d9d842f82c0102"><code>backup</code> - contains automatically <a href="#root/_help_ODY7qQn5m2FT">backup</a> of <li><code>backup</code> - contains automatically <a href="#root/_help_ODY7qQn5m2FT">backup</a> of
documents</li> documents</li>
<li data-list-item-id="e607bdb8fd7ebaf453623ba05ccd06625"><code>log</code> - contains application log files</li> <li><code>log</code> - contains application log files</li>
</ul> </ul>
<h2>Location of the data directory</h2> <h2>Location of the data directory</h2>
<p>Easy way how to find out which data directory Trilium uses is to look <p>Easy way how to find out which data directory Trilium uses is to look
@ -18,14 +18,11 @@
<p>Data directory is normally named <code>trilium-data</code> and it is stored <p>Data directory is normally named <code>trilium-data</code> and it is stored
in:</p> in:</p>
<ul> <ul>
<li data-list-item-id="eccf81a2f4d24647a0c925ee0fdf7d85b"><code>/home/[user]/.local/share</code> for Linux</li> <li><code>/home/[user]/.local/share</code> for Linux</li>
<li data-list-item-id="e0a4105e12f1eac1c654aa2497809c595"><code>C:\Users\[user]\AppData\Roaming</code> for Windows Vista and up</li> <li><code>C:\Users\[user]\AppData\Roaming</code> for Windows Vista and up</li>
<li <li><code>/Users/[user]/Library/Application Support</code> for Mac OS</li>
data-list-item-id="efa7faedd2f685103226ebc20ed8a7080"><code>/Users/[user]/Library/Application Support</code> for Mac OS</li> <li>user's home is a fallback if some of the paths above don't exist</li>
<li <li>user's home is also a default setup for [[docker|Docker server installation]]</li>
data-list-item-id="ea241b8e58d6fcf97d17f4eebb75e3262">user's home is a fallback if some of the paths above don't exist</li>
<li
data-list-item-id="ee543cb6057f45cc7dadf7a28d67588f3">user's home is also a default setup for [[docker|Docker server installation]]</li>
</ul> </ul>
<p>If you want to back up your Trilium data, just backup this single directory <p>If you want to back up your Trilium data, just backup this single directory
- it contains everything you need.</p> - it contains everything you need.</p>
@ -68,69 +65,61 @@
<h2>Fine-grained directory/path location</h2> <h2>Fine-grained directory/path location</h2>
<p>Apart from the data directory, some of the subdirectories of it can be <p>Apart from the data directory, some of the subdirectories of it can be
moved elsewhere by changing an environment variable:</p> moved elsewhere by changing an environment variable:</p>
<figure class="table" <table>
style="width:100%;"> <thead>
<table class="ck-table-resized"> <tr>
<colgroup> <th>Environment variable</th>
<col style="width:30.48%;"> <th>Default value</th>
<col style="width:39.54%;"> <th>Description</th>
<col style="width:29.98%;"> </tr>
</colgroup> </thead>
<thead> <tbody>
<tr> <tr>
<th>Environment variable</th> <td><code>TRILIUM_DOCUMENT_PATH</code>
<th>Default value</th> </td>
<th>Description</th> <td><code>${TRILIUM_DATA_DIR}/document.db</code>
</tr> </td>
</thead> <td>Path to the&nbsp;<a class="reference-link" href="#root/_help_wX4HbRucYSDD">Database</a>&nbsp;(storing
<tbody> all notes and metadata).</td>
<tr> </tr>
<td><code>TRILIUM_DOCUMENT_PATH</code> <tr>
</td> <td><code>TRILIUM_BACKUP_DIR</code>
<td><code>${TRILIUM_DATA_DIR}/document.db</code> </td>
</td> <td><code>${TRILIUM_DATA_DIR}/backup</code>
<td>Path to the&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_wX4HbRucYSDD">Database</a>&nbsp;(storing </td>
all notes and metadata).</td> <td>Directory where automated&nbsp;<a class="reference-link" href="#root/_help_ODY7qQn5m2FT">Backup</a>&nbsp;databases
</tr> are stored.</td>
<tr> </tr>
<td><code>TRILIUM_BACKUP_DIR</code> <tr>
</td> <td><code>TRILIUM_LOG_DIR</code>
<td><code>${TRILIUM_DATA_DIR}/backup</code> </td>
</td> <td><code>${TRILIUM_DATA_DIR}/log</code>
<td>Directory where automated&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_ODY7qQn5m2FT">Backup</a>&nbsp;databases </td>
are stored.</td> <td>Directory where daily&nbsp;<a class="reference-link" href="#root/_help_bnyigUA2UK7s">Backend (server) logs</a>&nbsp;are
</tr> stored.</td>
<tr> </tr>
<td><code>TRILIUM_LOG_DIR</code> <tr>
</td> <td><code>TRILIUM_TMP_DIR</code>
<td><code>${TRILIUM_DATA_DIR}/log</code> </td>
</td> <td><code>${TRILIUM_DATA_DIR}/tmp</code>
<td>Directory where daily&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/BgmBlOIl72jZ/qzNzp9LYQyPT/_help_bnyigUA2UK7s">Backend (server) logs</a>&nbsp;are </td>
stored.</td> <td>Directory where temporary files are stored (for example when opening in
</tr> an external app).</td>
<tr> </tr>
<td><code>TRILIUM_TMP_DIR</code> <tr>
</td> <td><code>TRILIUM_ANONYMIZED_DB_DIR</code>
<td><code>${TRILIUM_DATA_DIR}/tmp</code> </td>
</td> <td><code>${TRILIUM_DATA_DIR}/anonymized-db</code>
<td>Directory where temporary files are stored (for example when opening in </td>
an external app).</td> <td>Directory where a&nbsp;<a class="reference-link" href="#root/_help_x59R8J8KV5Bp">Anonymized Database</a>&nbsp;is
</tr> stored.</td>
<tr> </tr>
<td><code>TRILIUM_ANONYMIZED_DB_DIR</code> <tr>
</td> <td><code>TRILIUM_CONFIG_INI_PATH</code>
<td><code>${TRILIUM_DATA_DIR}/anonymized-db</code> </td>
</td> <td><code>${TRILIUM_DATA_DIR}/config.ini</code>
<td>Directory where a&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/BgmBlOIl72jZ/_help_x59R8J8KV5Bp">Anonymized Database</a>&nbsp;is </td>
stored.</td> <td>Path to&nbsp;<a class="reference-link" href="#root/_help_Gzjqa934BdH4">Configuration (config.ini or environment variables)</a>&nbsp;file.</td>
</tr> </tr>
<tr> </tbody>
<td><code>TRILIUM_CONFIG_INI_PATH</code> </table>
</td>
<td><code>${TRILIUM_DATA_DIR}/config.ini</code>
</td>
<td>Path to&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/tC7s2alapj8V/_help_Gzjqa934BdH4">Configuration (config.ini or environment variables)</a>&nbsp;file.</td>
</tr>
</tbody>
</table>
</figure>

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

@ -110,77 +110,77 @@
"name": "internalLink", "name": "internalLink",
"value": "NRnIZmSMc5sj", "value": "NRnIZmSMc5sj",
"isInheritable": false, "isInheritable": false,
"position": 60 "position": 50
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "rC3pL2aptaRE", "value": "rC3pL2aptaRE",
"isInheritable": false, "isInheritable": false,
"position": 70 "position": 60
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "xWbu3jpNWapp", "value": "xWbu3jpNWapp",
"isInheritable": false, "isInheritable": false,
"position": 80 "position": 70
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "81SGnPGMk7Xc", "value": "81SGnPGMk7Xc",
"isInheritable": false, "isInheritable": false,
"position": 90 "position": 80
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "iPIMuisry3hd", "value": "iPIMuisry3hd",
"isInheritable": false, "isInheritable": false,
"position": 100 "position": 90
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "ZlN4nump6EbW", "value": "ZlN4nump6EbW",
"isInheritable": false, "isInheritable": false,
"position": 110 "position": 100
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "pwc194wlRzcH", "value": "pwc194wlRzcH",
"isInheritable": false, "isInheritable": false,
"position": 120 "position": 110
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "7DAiwaf8Z7Rz", "value": "7DAiwaf8Z7Rz",
"isInheritable": false, "isInheritable": false,
"position": 130 "position": 120
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "veGu4faJErEM", "value": "veGu4faJErEM",
"isInheritable": false, "isInheritable": false,
"position": 140 "position": 130
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "AgjCISero73a", "value": "AgjCISero73a",
"isInheritable": false, "isInheritable": false,
"position": 150 "position": 140
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "gBbsAeiuUxI5", "value": "gBbsAeiuUxI5",
"isInheritable": false, "isInheritable": false,
"position": 160 "position": 150
}, },
{ {
"type": "label", "type": "label",
@ -1521,6 +1521,27 @@
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{
"type": "relation",
"name": "internalLink",
"value": "Gzjqa934BdH4",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "bnyigUA2UK7s",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "x59R8J8KV5Bp",
"isInheritable": false,
"position": 50
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -1534,27 +1555,6 @@
"value": "bx bx-folder-open", "value": "bx bx-folder-open",
"isInheritable": false, "isInheritable": false,
"position": 40 "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", "format": "markdown",
@ -5074,6 +5074,41 @@
"type": "text", "type": "text",
"mime": "text/html", "mime": "text/html",
"attributes": [ "attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "hrZ1D00cLbal",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "Oau6X9rCuegd",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "rJ9grSgoExl9",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "syuSEKf2rUGr",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "GnhlmrATVqcH",
"isInheritable": false,
"position": 50
},
{ {
"type": "label", "type": "label",
"name": "iconClass", "name": "iconClass",
@ -5087,41 +5122,6 @@
"value": "import-export", "value": "import-export",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "hrZ1D00cLbal",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "rJ9grSgoExl9",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "Oau6X9rCuegd",
"isInheritable": false,
"position": 50
},
{
"type": "relation",
"name": "internalLink",
"value": "syuSEKf2rUGr",
"isInheritable": false,
"position": 60
},
{
"type": "relation",
"name": "internalLink",
"value": "GnhlmrATVqcH",
"isInheritable": false,
"position": 70
} }
], ],
"format": "markdown", "format": "markdown",
@ -11545,24 +11545,31 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "zEY4DaJG4YT5", "value": "Cq5X6iKQop6R",
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "bdUJEHsAPYQR", "value": "hrZ1D00cLbal",
"isInheritable": false, "isInheritable": false,
"position": 20 "position": 20
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "iRwzGnHPzonm", "value": "bdUJEHsAPYQR",
"isInheritable": false, "isInheritable": false,
"position": 30 "position": 30
}, },
{
"type": "relation",
"name": "internalLink",
"value": "iRwzGnHPzonm",
"isInheritable": false,
"position": 40
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -11729,38 +11736,52 @@
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "bwZpz2ajCEwO", "value": "wX4HbRucYSDD",
"isInheritable": false, "isInheritable": false,
"position": 170 "position": 170
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "Wy267RK4M69c", "value": "ycBFjKrrwE9p",
"isInheritable": false, "isInheritable": false,
"position": 180 "position": 180
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "eIg8jdvaoNNd", "value": "bwZpz2ajCEwO",
"isInheritable": false, "isInheritable": false,
"position": 190 "position": 190
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "OFXdgB2nNk1F", "value": "Wy267RK4M69c",
"isInheritable": false, "isInheritable": false,
"position": 200 "position": 200
}, },
{ {
"type": "relation", "type": "relation",
"name": "internalLink", "name": "internalLink",
"value": "Qjt68inQ2bRj", "value": "eIg8jdvaoNNd",
"isInheritable": false, "isInheritable": false,
"position": 210 "position": 210
}, },
{
"type": "relation",
"name": "internalLink",
"value": "OFXdgB2nNk1F",
"isInheritable": false,
"position": 220
},
{
"type": "relation",
"name": "internalLink",
"value": "Qjt68inQ2bRj",
"isInheritable": false,
"position": 230
},
{ {
"type": "label", "type": "label",
"name": "shareAlias", "name": "shareAlias",
@ -11873,6 +11894,13 @@
"isInheritable": false, "isInheritable": false,
"position": 10 "position": 10
}, },
{
"type": "relation",
"name": "internalLink",
"value": "pgxEVkzLl1OP",
"isInheritable": false,
"position": 20
},
{ {
"type": "label", "type": "label",
"name": "iconClass", "name": "iconClass",
@ -11891,6 +11919,41 @@
"format": "markdown", "format": "markdown",
"dataFileName": "Exporting HTML for web publish.md", "dataFileName": "Exporting HTML for web publish.md",
"attachments": [] "attachments": []
},
{
"isClone": false,
"noteId": "sLIJ6f1dkJYW",
"notePath": [
"pOsGYCXsbNQG",
"tC7s2alapj8V",
"R9pX4DGra2Vt",
"sLIJ6f1dkJYW"
],
"title": "Reverse proxy configuration",
"notePosition": 30,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "label",
"name": "shareAlias",
"value": "reverse-proxy",
"isInheritable": false,
"position": 30
},
{
"type": "label",
"name": "iconClass",
"value": "bx bx-world",
"isInheritable": false,
"position": 40
}
],
"format": "markdown",
"dataFileName": "Reverse proxy configuration.md",
"attachments": []
} }
] ]
}, },

7
docs/User Guide/User Guide/Advanced Usage/Note Map (Link map, Tree map).md vendored
View File

@ -10,7 +10,12 @@ There are two types of note map:
## Link Map ## Link Map
Shows [relations](Attributes.md) between notes: The Link map is a visualization of links and <a class="reference-link" href="Attributes/Relations.md">Relations</a> incoming to and outgoing from a particular note.
The map indicates the following types of relations:
* <a class="reference-link" href="../Note%20Types/Text/Links/Internal%20(reference)%20links.md">Internal (reference) links</a> between notes.
* <a class="reference-link" href="Attributes/Relations.md">Relations</a>
![](1_Note%20Map%20\(Link%20map,%20Tree%20m.png) ![](1_Note%20Map%20\(Link%20map,%20Tree%20m.png)

28
docs/User Guide/User Guide/Advanced Usage/Sharing.md vendored
View File

@ -16,7 +16,7 @@ Trilium allows you to share selected notes as **publicly accessible** read-only
### By note type ### By note type
<table class="ck-table-resized"><colgroup><col style="width:19.92%;"><col style="width:41.66%;"><col style="width:38.42%;"></colgroup><thead><tr><th>&nbsp;</th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class="reference-link" href="../Note%20Types/Text.md">Text</a></th><td><ul><li data-list-item-id="e26b4ce9ba4e9dfe224d04e0f341925ed">Table of contents.</li><li data-list-item-id="e9707fdfa2c92d66690cf932f7e647253">Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li data-list-item-id="e84420a10c6d64bd107edb6e867c91d4b">Rendering for math equations.</li><li data-list-item-id="e10834dcd0619d77ae2e94d3695bedf58"><a href="../Note%20Types/Text/Include%20Note.md">Including notes</a> (only if the included notes are also shared).</li></ul></td><td><ul><li data-list-item-id="e41cc4139377f9f88d653d1eb8ca47bb4">Inline Mermaid diagrams are not rendered.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Code.md">Code</a></th><td><ul><li data-list-item-id="e291ae6d5130677b4c99f7c3bdbe974b4">Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li data-list-item-id="e0270680bbdd7a129306e61e11691e36d">No syntax highlight.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Saved%20Search.md">Saved Search</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Relation%20Map.md">Relation Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Collections.md">Collections</a></th><td><ul><li data-list-item-id="ea031e1d4149eb443ace756234490c5a4">The child notes are displayed in a fixed format.&nbsp;</li></ul></td><td><ul><li data-list-item-id="ea4a9d424aec2afbaecc07bbf64b7bebd">More advanced view types such as the calendar view are not supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></th><td><ul><li data-list-item-id="e582d283f2b1b30cbe5ae35d8e01b2bf2">The diagram is displayed as a vector image.</li></ul></td><td><ul><li data-list-item-id="e33268686446e3c217077201bb5964364">No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a></th><td><ul><li data-list-item-id="e443dd0e97c30cb12c77e8906a71569ea">The diagram is displayed as a vector image.</li></ul></td><td><ul><li data-list-item-id="efe151ef3f3826c825416417525fb5fb2">No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li data-list-item-id="ed3b4fb473042f6e32b4502d4fa11a767">No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Collections/Geo%20Map.md">Geo Map View</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/File.md">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li data-list-item-id="ed87e836a39d127ebcbb33e9e59045afb">No further interaction supported.</li></ul></td></tr></tbody></table> <table class="ck-table-resized"><colgroup><col style="width:19.92%;"><col style="width:41.66%;"><col style="width:38.42%;"></colgroup><thead><tr><th>&nbsp;</th><th>Supported features</th><th>Limitations</th></tr></thead><tbody><tr><th><a class="reference-link" href="../Note%20Types/Text.md">Text</a></th><td><ul><li data-list-item-id="e26b4ce9ba4e9dfe224d04e0f341925ed">Table of contents.</li><li data-list-item-id="e9707fdfa2c92d66690cf932f7e647253">Syntax highlight of code blocks, provided a language is selected (does not work if “Auto-detected” is enabled).</li><li data-list-item-id="e84420a10c6d64bd107edb6e867c91d4b">Rendering for math equations.</li><li data-list-item-id="e10834dcd0619d77ae2e94d3695bedf58"><a href="../Note%20Types/Text/Include%20Note.md">Including notes</a> (only if the included notes are also shared).</li></ul></td><td><ul><li data-list-item-id="e41cc4139377f9f88d653d1eb8ca47bb4">Inline Mermaid diagrams are not rendered.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Code.md">Code</a></th><td><ul><li data-list-item-id="e291ae6d5130677b4c99f7c3bdbe974b4">Basic support (displaying the contents of the note in a monospace font).</li></ul></td><td><ul><li data-list-item-id="e0270680bbdd7a129306e61e11691e36d">No syntax highlight.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Saved%20Search.md">Saved Search</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Relation%20Map.md">Relation Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Note%20Map.md">Note Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Render%20Note.md">Render Note</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Collections.md">Collections</a></th><td><ul><li data-list-item-id="ea031e1d4149eb443ace756234490c5a4">The child notes are displayed in a fixed format.&nbsp;</li></ul></td><td><ul><li data-list-item-id="ea4a9d424aec2afbaecc07bbf64b7bebd">More advanced view types such as the calendar view are not supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mermaid%20Diagrams.md">Mermaid Diagrams</a></th><td><ul><li data-list-item-id="e582d283f2b1b30cbe5ae35d8e01b2bf2">The diagram is displayed as a vector image.</li></ul></td><td><ul><li data-list-item-id="e33268686446e3c217077201bb5964364">No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Canvas.md">Canvas</a></th><td><ul><li data-list-item-id="e443dd0e97c30cb12c77e8906a71569ea">The diagram is displayed as a vector image.</li></ul></td><td><ul><li data-list-item-id="efe151ef3f3826c825416417525fb5fb2">No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Note%20Types/Web%20View.md">Web View</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/Mind%20Map.md">Mind Map</a></th><td>The diagram is displayed as a vector image.</td><td><ul><li data-list-item-id="ed3b4fb473042f6e32b4502d4fa11a767">No further interaction supported.</li></ul></td></tr><tr><th><a class="reference-link" href="../Collections/Geo%20Map.md">Geo Map</a></th><td>Not supported.</td><td>&nbsp;</td></tr><tr><th><a class="reference-link" href="../Note%20Types/File.md">File</a></th><td>Basic interaction (downloading the file).</td><td><ul><li data-list-item-id="ed87e836a39d127ebcbb33e9e59045afb">No further interaction supported.</li></ul></td></tr></tbody></table>
While the sharing feature is powerful, it has some limitations: While the sharing feature is powerful, it has some limitations:
@ -48,7 +48,9 @@ You can view a list of all shared notes by clicking on "Show Shared Notes Subtre
## Security considerations ## Security considerations
Shared notes are published on the open internet and can be accessed by anyone with the URL. The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature. * Shared notes are published on the open internet and can be accessed by anyone with the URL unless the notes are password-protected.
* The URL's randomness does not provide security, so it is crucial not to share sensitive information through this feature.
* Trilium takes precautions to protect your publicly shared instance from leaking information for non-shared notes, including opening a separate read-only connection to the <a class="reference-link" href="Database.md">Database</a>. Depending on your threat model, it might make more sense to use <a class="reference-link" href="Sharing/Exporting%20HTML%20for%20web%20publish.md">Exporting HTML for web publishing</a> and use battle-tested web servers such as Nginx or Apache to serve static content.
### Password protection ### Password protection
@ -129,7 +131,27 @@ To do so, create a shared text note and apply the `shareIndex` label. When viewe
## Attribute reference ## Attribute reference
<table><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>shareHiddenFromTree</code></td><td>this note is hidden from left navigation tree, but still accessible with its URL</td></tr><tr><td><code>shareExternalLink</code></td><td>note will act as a link to an external website in the share tree</td></tr><tr><td><code>shareAlias</code></td><td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code></td></tr><tr><td><code>shareOmitDefaultCss</code></td><td>default share page CSS will be omitted. Use when you make extensive styling changes.</td></tr><tr><td><code>shareRoot</code></td><td>marks note which is served on /share root.</td></tr><tr><td><code>shareDescription</code></td><td>define text to be added to the HTML meta tag for description</td></tr><tr><td><code>shareRaw</code></td><td>Note will be served in its raw format, without HTML wrapper. See also&nbsp;<a class="reference-link" href="Sharing/Serving%20directly%20the%20content%20o.md">Serving directly the content of a note</a>&nbsp;for an alternative method without setting an attribute.</td></tr><tr><td><code>shareDisallowRobotIndexing</code></td><td><p>Indicates to web crawlers that the page should not be indexed of this note by:</p><ul><li data-list-item-id="e6baa9f60bf59d085fd31aa2cce07a0e7">Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li><li data-list-item-id="ec0d067db136ef9794e4f1033405880b7">Setting the <code>noindex, follow</code> meta tag.</li></ul></td></tr><tr><td><code>shareCredentials</code></td><td>require credentials to access this shared note. Value is expected to be in format <code>username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td></tr><tr><td><code>shareIndex</code></td><td>Note with this label will list all roots of shared notes.</td></tr><tr><td><code>shareHtmlLocation</code></td><td>defines where custom HTML injected via <code>~shareHtml</code> relation should be placed. Applied to the HTML snippet note itself. Format: <code>location:position</code> where location is <code>head</code>, <code>body</code>, or <code>content</code> and position is <code>start</code> or <code>end</code>. Defaults to <code>content:end</code>.</td></tr></tbody></table> <table class="ck-table-resized"><colgroup><col style="width:18.38%;"><col style="width:81.62%;"></colgroup><thead><tr><th>Attribute</th><th>Description</th></tr></thead><tbody><tr><td><code>#shareHiddenFromTree</code></td><td>this note is hidden from left navigation tree, but still accessible with its URL</td></tr><tr><td><code>#shareExternalLink</code></td><td>note will act as a link to an external website in the share tree</td></tr><tr><td><code>#shareAlias</code></td><td>define an alias using which the note will be available under <code>https://your_trilium_host/share/[your_alias]</code></td></tr><tr><td><code>#shareOmitDefaultCss</code></td><td>default share page CSS will be omitted. Use when you make extensive styling changes.</td></tr><tr><td><code>#shareRoot</code></td><td>marks note which is served on /share root.</td></tr><tr><td><code>#shareDescription</code></td><td>define text to be added to the HTML meta tag for description</td></tr><tr><td><code>#shareRaw</code></td><td>Note will be served in its raw format, without HTML wrapper. See also&nbsp;<a class="reference-link" href="Sharing/Serving%20directly%20the%20content%20o.md">Serving directly the content of a note</a>&nbsp;for an alternative method without setting an attribute.</td></tr><tr><td><code>#shareDisallowRobotIndexing</code></td><td><p>Indicates to web crawlers that the page should not be indexed of this note by:</p><ul><li data-list-item-id="e6baa9f60bf59d085fd31aa2cce07a0e7">Setting the <code>X-Robots-Tag: noindex</code> HTTP header.</li><li data-list-item-id="ec0d067db136ef9794e4f1033405880b7">Setting the <code>noindex, follow</code> meta tag.</li></ul></td></tr><tr><td><code>#shareCredentials</code></td><td>require credentials to access this shared note. Value is expected to be in format <code>username:password</code>. Don't forget to make this inheritable to apply to child-notes/images.</td></tr><tr><td><code>#shareIndex</code></td><td>Note with this label will list all roots of shared notes.</td></tr><tr><td><code>#shareHtmlLocation</code></td><td>defines where custom HTML injected via <code>~shareHtml</code> relation should be placed. Applied to the HTML snippet note itself. Format: <code>location:position</code> where location is <code>head</code>, <code>body</code>, or <code>content</code> and position is <code>start</code> or <code>end</code>. Defaults to <code>content:end</code>.</td></tr></tbody></table>
### Customizing logo
It's possible to adjust the logo which is displayed on the top-left of the left pane.
| Attribute | Description |
| --- | --- |
| `~shareLogo` | Relation set to an image to use as logo. The image must be part of the share tree (it can be hidden if needed). |
| `#shareLogoWidth` | The width (in pixels, without unit) to set for the logo. Default is `53`. |
| `#shareLogoHeight` | The height (in pixels, without unit) to set for the logo. Default is `40`. |
| `#shareRootLink` | URL to navigate to when the logo is pressed. |
### Customizing OpenGraph
| Attribute | Description |
| --- | --- |
| `#shareOpenGraphColor` | This adjusts the `theme-color` meta-property. |
| `#shareOpenGraphURL` | This adjusts the `og:url` and `twitter:url` meta-properties. |
| `#shareOpenGraphDomain` | Adjusts the `twitter:domain` meta-property. |
| `#shareOpenGraphImage` <br>`~shareOpenGraphImage` | Can be either a label, case in which the value is passed on as-is, or it can be a relation to an image <a class="reference-link" href="../Note%20Types/File.md">File</a>. This controls the `og:image` meta-property. |
## Credits ## Credits

8
docs/User Guide/User Guide/Advanced Usage/Sharing/Exporting HTML for web publish.md vendored
View File

@ -10,7 +10,7 @@ Apart from the enhanced security, these HTML files are also easy to deploy on
> >
> The process is [automated](https://github.com/TriliumNext/Trilium/blob/main/apps/edit-docs/src/build-docs.ts) by importing the Markdown documentation and exporting it via a script to the static web format. > The process is [automated](https://github.com/TriliumNext/Trilium/blob/main/apps/edit-docs/src/build-docs.ts) by importing the Markdown documentation and exporting it via a script to the static web format.
## Differences from normal sharing and export ## Differences from normal sharing
Apart from normal <a class="reference-link" href="../Sharing.md">Sharing</a>, exporting to static HTML files comes with a few subtle differences: Apart from normal <a class="reference-link" href="../Sharing.md">Sharing</a>, exporting to static HTML files comes with a few subtle differences:
@ -38,4 +38,8 @@ Once installed simply:
1. Extract the exported .zip file. 1. Extract the exported .zip file.
2. Inside the extracted directory, run `http-server`. 2. Inside the extracted directory, run `http-server`.
3. Access the indicated address (e.g. [http://localhost:8080](http://localhost:8080)). 3. Access the indicated address (e.g. [http://localhost:8080](http://localhost:8080)).
## Automation
<a class="reference-link" href="../ETAPI%20(REST%20API).md">ETAPI (REST API)</a> could potentially be used to automate an export on a scheduled task.

18
docs/User Guide/User Guide/Advanced Usage/Sharing/Reverse proxy configuration.md vendored Normal file
View File

@ -0,0 +1,18 @@
# Reverse proxy configuration
It might be desirable to only expose the share functionality of Trilium to the Internet, and keep the application accessible only within a local network or via VPN.
To do so, a reverse proxy is required.
## Caddy
```
http://domain.com {
reverse_proxy /share http://localhost:8080/share
}
```
This is for newer versions where the share functionality is isolated, for older versions it's required to also include `/assets`.<sup><a href="#fn2b8mg20aol8">[1]</a></sup>
1. <sup><strong><a href="#fnref2b8mg20aol8">^</a></strong></sup>
[https://github.com/orgs/TriliumNext/discussions/7341#discussioncomment-14679897](https://github.com/orgs/TriliumNext/discussions/7341#discussioncomment-14679897)