Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-11-09 06:45:49 +01:00
Code Issues Packages Projects Releases Activity

docs(user): mention structure difference

Browse Source
This commit is contained in:
Elian Doran
2025-11-04 23:13:34 +02:00
parent 3359ff5470
commit c2ce36d963
6 changed files with 33 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -12093,7 +12093,7 @@
"R9pX4DGra2Vt",
"ycBFjKrrwE9p"
],
"title": "Exporting HTML for web publishing",
"title": "Exporting static HTML for web publishing",
"notePosition": 20,
"prefix": null,
"isExpanded": false,
@@ -12130,7 +12130,7 @@
}
],
"format": "markdown",
"dataFileName": "Exporting HTML for web publish.md",
"dataFileName": "Exporting static HTML for web .md",
"attachments": []
},
{

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

@@ -50,7 +50,7 @@ You can view a list of all shared notes by clicking on "Show Shared Notes Subtre
* 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.
* 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%20static%20HTML%20for%20web%20.md">Exporting HTML for web publishing</a> and use battle-tested web servers such as Nginx or Apache to serve static content.
### Password protection

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

@@ -1,4 +1,4 @@
# Exporting HTML for web publishing
# Exporting static HTML for web publishing
As described in <a class="reference-link" href="../Sharing.md">Sharing</a>, Trilium can act as a public server in which the shared notes are displayed in read-only mode. While this can work in most cases, it's generally not meant for high-traffic websites and since it's running on a Node.js server it can be potentially exploited.
Another alternative is to generate static HTML files (just like other static site generators such as [MkDocs](https://www.mkdocs.org/)). Since the normal HTML ZIP export does not contain any styling or additional functionality, Trilium provides a way to export the same layout and style as the <a class="reference-link" href="../Sharing.md">Sharing</a> function into static HTML files.
@@ -23,6 +23,10 @@ Apart from normal <a class="reference-link" href="../Sharing.md">Sharing</a>, e
* The name of the files/URLs will prefer `shareAlias` to allow for clean URLs.
* The export requires a functional web server as the pages will not render properly if accessed locally via a web browser due to the use of module scripts.
* The directory structure is also slightly different:
* A normal HTML export results in an index file and a single directory.
* Instead, for static exporting the top-root level becomes the index file and the child directories are on the root instead.
* This makes it possible to easily publish to a website, without forcing everything but the root note to be in a sub-directory.
## Testing locally