feat(docs): document multiple server instances & reorganize

This commit is contained in:
Elian Doran
2025-04-11 23:32:53 +03:00
parent 7c88681e70
commit 0acdab29af
17 changed files with 356 additions and 57 deletions

View File

@@ -236,7 +236,7 @@
"Dgg7bR3b6K9j",
"3tW6mORuTHnB"
],
"title": "Packaged server installation",
"title": "Packaged version for Linux",
"notePosition": 10,
"prefix": null,
"isExpanded": false,
@@ -263,10 +263,17 @@
"value": "packaged-server-installation",
"isInheritable": false,
"position": 20
},
{
"type": "label",
"name": "iconClass",
"value": "bx bxl-tux",
"isInheritable": false,
"position": 30
}
],
"format": "html",
"dataFileName": "Packaged server installation.html",
"dataFileName": "Packaged version for Linux.html",
"attachments": []
},
{
@@ -279,7 +286,7 @@
"Dgg7bR3b6K9j",
"rWX5eY045zbE"
],
"title": "Docker Server Installation",
"title": "Using Docker",
"notePosition": 20,
"prefix": null,
"isExpanded": false,
@@ -306,10 +313,17 @@
"value": "docker-server-installation",
"isInheritable": false,
"position": 30
},
{
"type": "label",
"name": "iconClass",
"value": "bx bxl-docker",
"isInheritable": false,
"position": 40
}
],
"format": "html",
"dataFileName": "Docker Server Installation.html",
"dataFileName": "Using Docker.html",
"attachments": []
},
{
@@ -322,7 +336,7 @@
"Dgg7bR3b6K9j",
"moVgBcoxE3EK"
],
"title": "NixOS server installation",
"title": "On NixOS",
"notePosition": 30,
"prefix": null,
"isExpanded": false,
@@ -335,10 +349,17 @@
"value": "nixos-server-installation",
"isInheritable": false,
"position": 10
},
{
"type": "label",
"name": "iconClass",
"value": "bx bxl-tux",
"isInheritable": false,
"position": 20
}
],
"format": "html",
"dataFileName": "NixOS server installation.html",
"dataFileName": "On NixOS.html",
"attachments": []
},
{
@@ -351,7 +372,7 @@
"Dgg7bR3b6K9j",
"J1Bb6lVlwU5T"
],
"title": "Manual server installation",
"title": "Manually",
"notePosition": 40,
"prefix": null,
"isExpanded": false,
@@ -371,10 +392,31 @@
"value": "manual-server-installation",
"isInheritable": false,
"position": 20
},
{
"type": "label",
"name": "iconClass",
"value": "bx bx-code-alt",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "rWX5eY045zbE",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "3tW6mORuTHnB",
"isInheritable": false,
"position": 50
}
],
"format": "html",
"dataFileName": "Manual server installation.html",
"dataFileName": "Manually.html",
"attachments": []
},
{
@@ -387,7 +429,7 @@
"Dgg7bR3b6K9j",
"DCmT6e7clMoP"
],
"title": "Kubernetes server installation",
"title": "Using Kubernetes",
"notePosition": 50,
"prefix": null,
"isExpanded": false,
@@ -400,10 +442,81 @@
"value": "kubernetes-server-installation",
"isInheritable": false,
"position": 10
},
{
"type": "label",
"name": "iconClass",
"value": "bx bxl-kubernetes",
"isInheritable": false,
"position": 20
}
],
"format": "html",
"dataFileName": "Kubernetes server installation.html",
"dataFileName": "Using Kubernetes.html",
"attachments": []
},
{
"isClone": false,
"noteId": "klCWNks3ReaQ",
"notePath": [
"pOsGYCXsbNQG",
"Otzi9La2YAUX",
"WOcw2SLH6tbX",
"Dgg7bR3b6K9j",
"klCWNks3ReaQ"
],
"title": "Multiple server instances",
"notePosition": 60,
"prefix": null,
"isExpanded": false,
"type": "text",
"mime": "text/html",
"attributes": [
{
"type": "relation",
"name": "internalLink",
"value": "cbkrhQjrkKrh",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
"value": "3tW6mORuTHnB",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
"value": "rWX5eY045zbE",
"isInheritable": false,
"position": 30
},
{
"type": "relation",
"name": "internalLink",
"value": "moVgBcoxE3EK",
"isInheritable": false,
"position": 40
},
{
"type": "relation",
"name": "internalLink",
"value": "J1Bb6lVlwU5T",
"isInheritable": false,
"position": 50
},
{
"type": "label",
"name": "iconClass",
"value": "bx bxs-user-account",
"isInheritable": false,
"position": 60
}
],
"format": "html",
"dataFileName": "Multiple server instances.html",
"attachments": []
}
]

View File

@@ -5,16 +5,21 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../../style.css">
<base target="_parent">
<title data-trilium-title>Manual server installation</title>
<title data-trilium-title>Manually</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Manual server installation</h1>
<h1 data-trilium-h1>Manually</h1>
<div class="ck-content">
<p>This page describes manually installing Trilium on your server. <strong>Note that this is a not well supported way to install Trilium, problems may appear, information laid out here is quite out of date. It is recommended to use either Docker or packaged build installation.</strong>
</p>
<aside class="admonition warning">
<p>This page describes manually installing Trilium on your server. <strong>Note that this is a not well supported way to install Trilium, problems may appear, information laid out here is quite out of date. It is recommended to use either&nbsp;</strong>
<a
class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/WOcw2SLH6tbX/Dgg7bR3b6K9j/_help_rWX5eY045zbE">Docker Server Installation</a><strong>&nbsp;or&nbsp;</strong><a class="reference-link"
href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/WOcw2SLH6tbX/Dgg7bR3b6K9j/_help_3tW6mORuTHnB">Packaged server installation</a><strong>.</strong>
</p>
</aside>
<h2>Requirements</h2>
<p>Trilium is a node.js application. Supported (tested) version of node.js
is latest 14.X.X and 16.X.X. Trilium might work with older versions as

View File

@@ -0,0 +1,42 @@
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../../style.css">
<base target="_parent">
<title data-trilium-title>Multiple server instances</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Multiple server instances</h1>
<div class="ck-content">
<p>Trilium does not support multiple users. In order to have two or more
persons with their own set of notes, multiple server instances must be
set up. It is also not possible to use multiple <a href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_cbkrhQjrkKrh">sync</a> servers.</p>
<p>To allow multiple server instances on a single physical server:</p>
<ul>
<li>
<p>For&nbsp;<a class="reference-link" href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/WOcw2SLH6tbX/Dgg7bR3b6K9j/_help_3tW6mORuTHnB">Packaged version for Linux</a>&nbsp;or&nbsp;
<a
class="reference-link" href="#root/Dgg7bR3b6K9j/_help_J1Bb6lVlwU5T">Manually</a>, if starting the server manually just specify a different
port and data directory per instance:</p><pre><code class="language-text-x-trilium-auto">TRILIUM_NETWORK_PORT=8080 TRILIUM_DATA_DIR=/path/to/your/data-dir-A /opt/trilium/trilium.sh</code></pre>
<p>For a second instance:</p><pre><code class="language-text-x-trilium-auto">TRILIUM_NETWORK_PORT=8081 TRILIUM_DATA_DIR=/path/to/your/data-dir-B /opt/trilium/trilium.sh</code></pre>
<p>If using <code>systemd</code>, then set the <a href="https://serverfault.com/questions/413397/how-to-set-environment-variable-in-systemd-service">environment variables in the service configuration</a>.</p>
<p>&nbsp;</p>
</li>
<li>For&nbsp;<a class="reference-link" href="#root/Dgg7bR3b6K9j/_help_rWX5eY045zbE">Using Docker</a>,
simply use two different containers, each with their own port binding and
data directory.</li>
<li>For&nbsp;<a class="reference-link" href="#root/Dgg7bR3b6K9j/_help_moVgBcoxE3EK">On NixOS</a>,
the only possible way is to use Docker OCI containers or at least one NixOS
container with its own service definition.</li>
</ul>
<p>For support or additional context, see the related <a href="https://github.com/orgs/TriliumNext/discussions/1642#discussioncomment-12768808">GitHub Discussion</a>.</p>
</div>
</div>
</body>
</html>

View File

@@ -5,12 +5,12 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../../style.css">
<base target="_parent">
<title data-trilium-title>NixOS server installation</title>
<title data-trilium-title>On NixOS</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>NixOS server installation</h1>
<h1 data-trilium-h1>On NixOS</h1>
<div class="ck-content">
<p>This page describes configuring the Trilium module included in NixOS.</p>

View File

@@ -5,12 +5,12 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../../style.css">
<base target="_parent">
<title data-trilium-title>Packaged server installation</title>
<title data-trilium-title>Packaged version for Linux</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Packaged server installation</h1>
<h1 data-trilium-h1>Packaged version for Linux</h1>
<div class="ck-content">
<p>This is essentially Trilium sources + node modules + node.js runtime packaged

View File

@@ -5,12 +5,12 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../../style.css">
<base target="_parent">
<title data-trilium-title>Docker Server Installation</title>
<title data-trilium-title>Using Docker</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Docker Server Installation</h1>
<h1 data-trilium-h1>Using Docker</h1>
<div class="ck-content">
<p>Official docker images are published on docker hub for <strong>AMD64</strong>, <strong>ARMv7</strong> and <strong>ARM64/v8</strong>:
@@ -51,8 +51,8 @@
<h3>Running the Docker Container</h3>
<h4>Local Access Only</h4>
<p>Run the container to make it accessible only from the localhost. This
setup is suitable for testing or when using a proxy server like Nginx or
Apache.</p><pre><code class="language-text-x-trilium-auto">sudo docker run -t -i -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION]</code></pre>
setup is suitable for testing or when using a prox ay server like Nginx
or Apache.</p><pre><code class="language-text-x-trilium-auto">sudo docker run -t -i -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION]</code></pre>
<ol>
<li>Verify the container is running using <code>docker ps</code>.</li>
<li>Access Trilium via a web browser at <code>127.0.0.1:8080</code>.</li>

View File

@@ -5,12 +5,12 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../../../../style.css">
<base target="_parent">
<title data-trilium-title>Kubernetes server installation</title>
<title data-trilium-title>Using Kubernetes</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>Kubernetes server installation</h1>
<h1 data-trilium-h1>Using Kubernetes</h1>
<div class="ck-content">
<p>As Trilium can be run in Docker it also can be deployed in Kubernetes.

View File

@@ -19,20 +19,23 @@
<ul>
<li>1. Installing the server
<ul>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/Packaged%20server%20installation.html"
target="detail">Packaged server installation</a>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/Packaged%20version%20for%20Linux.html"
target="detail">Packaged version for Linux</a>
</li>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/Docker%20Server%20Installation.html"
target="detail">Docker Server Installation</a>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.html"
target="detail">Using Docker</a>
</li>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/NixOS%20server%20installation.html"
target="detail">NixOS server installation</a>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/On%20NixOS.html"
target="detail">On NixOS</a>
</li>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/Manual%20server%20installation.html"
target="detail">Manual server installation</a>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/Manually.html"
target="detail">Manually</a>
</li>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/Kubernetes%20server%20installation.html"
target="detail">Kubernetes server installation</a>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/Using%20Kubernetes.html"
target="detail">Using Kubernetes</a>
</li>
<li><a href="User%20Guide/Installation%20%26%20Setup/Server%20Installation/1.%20Installing%20the%20server/Multiple%20server%20instances.html"
target="detail">Multiple server instances</a>
</li>
</ul>
</li>