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": "markdown",
"dataFileName": "Packaged server installation.md",
"dataFileName": "Packaged version for Linux.md",
"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": "markdown",
"dataFileName": "Docker Server Installation.md",
"dataFileName": "Using Docker.md",
"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": "markdown",
"dataFileName": "NixOS server installation.md",
"dataFileName": "On NixOS.md",
"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": "markdown",
"dataFileName": "Manual server installation.md",
"dataFileName": "Manually.md",
"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": "markdown",
"dataFileName": "Kubernetes server installation.md",
"dataFileName": "Using Kubernetes.md",
"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": "markdown",
"dataFileName": "Multiple server instances.md",
"attachments": []
}
]

View File

@@ -5,14 +5,14 @@ This guide outlines the steps to install Trilium on your own server. You might c
There are several ways to install Trilium on a server, each with its own advantages:
* **Recommended**: [Docker Installation](Server%20Installation/1.%20Installing%20the%20server/Docker%20Server%20Installation.md) - Available for **AMD64** and **ARM** architectures.
* [Packaged Server Installation](Server%20Installation/1.%20Installing%20the%20server/Packaged%20server%20installation.md)
* **Recommended**: [Docker Installation](Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md) - Available for **AMD64** and **ARM** architectures.
* [Packaged Server Installation](Server%20Installation/1.%20Installing%20the%20server/Packaged%20version%20for%20Linux.md)
* [PikaPods managed hosting](https://www.pikapods.com/pods?run=trilium-next)
* [Manual Installation](Server%20Installation/1.%20Installing%20the%20server/Manual%20server%20installation.md)
* [Kubernetes](Server%20Installation/1.%20Installing%20the%20server/Kubernetes%20server%20installation.md)
* [Manual Installation](Server%20Installation/1.%20Installing%20the%20server/Manually.md)
* [Kubernetes](Server%20Installation/1.%20Installing%20the%20server/Using%20Kubernetes.md)
* [Cloudron](https://www.cloudron.io/store/com.github.trilium.cloudronapp.html)
* [HomelabOS](https://homelabos.com/docs/software/trilium/)
* [NixOS Module](Server%20Installation/1.%20Installing%20the%20server/NixOS%20server%20installation.md)
* [NixOS Module](Server%20Installation/1.%20Installing%20the%20server/On%20NixOS.md)
The server installation includes both web and [mobile frontends](Mobile%20Frontend.md).

View File

@@ -1,5 +1,6 @@
# Manual server installation
This page describes manually installing Trilium on your server. **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.**
# Manually
> [!WARNING]
> This page describes manually installing Trilium on your server. **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** <a class="reference-link" href="Using%20Docker.md">Docker Server Installation</a> **or** <a class="reference-link" href="Packaged%20version%20for%20Linux.md">Packaged server installation</a>**.**
## Requirements

View File

@@ -0,0 +1,22 @@
# Multiple server instances
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 [sync](../../Synchronization.md) servers.
To allow multiple server instances on a single physical server:
* For <a class="reference-link" href="Packaged%20version%20for%20Linux.md">Packaged version for Linux</a> or <a class="reference-link" href="Manually.md">Manually</a>, if starting the server manually just specify a different port and data directory per instance:
```
TRILIUM_NETWORK_PORT=8080 TRILIUM_DATA_DIR=/path/to/your/data-dir-A /opt/trilium/trilium.sh
```
For a second instance:
```
TRILIUM_NETWORK_PORT=8081 TRILIUM_DATA_DIR=/path/to/your/data-dir-B /opt/trilium/trilium.sh
```
If using `systemd`, then set the [environment variables in the service configuration](https://serverfault.com/questions/413397/how-to-set-environment-variable-in-systemd-service).
* For <a class="reference-link" href="Using%20Docker.md">Using Docker</a>, simply use two different containers, each with their own port binding and data directory.
* For <a class="reference-link" href="On%20NixOS.md">On NixOS</a>, the only possible way is to use Docker OCI containers or at least one NixOS container with its own service definition.
For support or additional context, see the related [GitHub Discussion](https://github.com/orgs/TriliumNext/discussions/1642#discussioncomment-12768808).

View File

@@ -1,4 +1,4 @@
# NixOS server installation
# On NixOS
This page describes configuring the Trilium module included in NixOS.
## Requirements

View File

@@ -1,4 +1,4 @@
# Packaged server installation
# Packaged version for Linux
This is essentially Trilium sources + node modules + node.js runtime packaged into one 7z file.
## Steps

View File

@@ -1,4 +1,4 @@
# Docker Server Installation
# Using Docker
Official docker images are published on docker hub for **AMD64**, **ARMv7** and **ARM64/v8**: [https://hub.docker.com/r/triliumnext/notes/](https://hub.docker.com/r/triliumnext/notes/)
## Prerequisites
@@ -50,7 +50,7 @@ Trilium requires a directory on the host system to store its data. This director
#### Local Access Only
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.
Run the container to make it accessible only from the localhost. This setup is suitable for testing or when using a prox ay server like Nginx or Apache.
```
sudo docker run -t -i -p 127.0.0.1:8080:8080 -v ~/trilium-data:/home/node/trilium-data triliumnext/notes:[VERSION]

View File

@@ -1,4 +1,4 @@
# Kubernetes server installation
# Using Kubernetes
As Trilium can be run in Docker it also can be deployed in Kubernetes. You can either use our Helm chart, a community Helm chart, or roll your own Kubernetes deployment.
The recommended way is to use a Helm chart.

View File

@@ -5,7 +5,7 @@ This document outlines the steps required to upgrade Trilium to a new release ve
Trilium does not support built-in automatic upgrades; all updates must be performed manually. The upgrade process varies depending on the installation method:
* [**Docker Server Installation**](Server%20Installation/1.%20Installing%20the%20server/Docker%20Server%20Installation.md): Pull the new image and restart the container.
* [**Docker Server Installation**](Server%20Installation/1.%20Installing%20the%20server/Using%20Docker.md): Pull the new image and restart the container.
* **Other Installations**: Download the latest version from the [release page](https://github.com/TriliumNext/Notes/releases/latest) and replace the existing application files.
## Database Compatibility and Migration