From 988a2b8d2968ce95518b88ce720bf1432e086a9a Mon Sep 17 00:00:00 2001
From: Jin <22962980+JYC333@users.noreply.github.com>
Date: Mon, 9 Jun 2025 17:22:09 +0200
Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Add=20custom=20OAu?=
=?UTF-8?q?th=20issuer=20docs?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
.../Server Installation.html | 2 +-
.../2. Reverse proxy/Nginx.html | 16 ++++++---
.../Server Installation/Authentication.html | 12 +++----
.../Multi-Factor Authentication.html | 14 +++++---
.../Theme development/Reference.html | 3 +-
docs/Developer Guide/!!!meta.json | 2 +-
docs/Release Notes/!!!meta.json | 2 +-
docs/Release Notes/Release Notes/v0.94.1.md | 2 +-
docs/User Guide/!!!meta.json | 36 +++++++++----------
.../2. Reverse proxy/Nginx.md | 2 +-
.../Server Installation/Authentication.md | 2 +-
.../Multi-Factor Authentication.md | 8 ++---
.../User Guide/Theme development/Reference.md | 2 +-
13 files changed, 57 insertions(+), 46 deletions(-)
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation.html
index bf9406106..c1fcde150 100644
--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation.html
+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation.html
@@ -46,7 +46,7 @@
variable to something larger than the integer 250
(e.g. 450
in
the following example):
export MAX_ALLOWED_FILE_SIZE_MB=450
See Authentication.
+See Authentication.
To configure a reverse proxy for Trilium, you can use either nginx or Apache. You can also check out the documentation stored in the Reverse proxy folder.
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.html index 46ac6f4fb..7b7e958a0 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.html @@ -10,7 +10,14 @@ vim default.confFill the file with the context shown below, part of the setting show be - changed. Then you can enjoy your web with HTTPS forced and proxy.
# This part is for proxy and HTTPS configure
+ changed. Then you can enjoy your web with HTTPS forced and proxy.# This part configures, where your Trilium server is running
+upstream trilium {
+ zone trilium 64k;
+ server 127.0.0.1:8080; # change it to a different hostname and port if non-default is used
+ keepalive 2;
+}
+
+# This part is for proxy and HTTPS configure
server {
listen 443 ssl;
server_name trilium.example.net; #change trilium.example.net to your domain without HTTPS or HTTP.
@@ -29,9 +36,8 @@ server {
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
- proxy_pass http://127.0.0.1:8080; # change it to a different port if non-default is used
+ proxy_pass http://trilium;
proxy_read_timeout 90;
- proxy_redirect http://127.0.0.1:8080 https://trilium.example.net; # change them based on your IP, port and domain
}
}
@@ -52,16 +58,16 @@ server {
add the proxy_cookie_path
directive with the same path: this
allows you to stay logged in at multiple instances at the same time.
location /trilium/instance-one {
+ rewrite /trilium/instance-one/(.*) /$1 break;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
- proxy_pass http://127.0.0.1:8080; # change it to a different port if non-default is used
+ proxy_pass http://trilium;
proxy_cookie_path / /trilium/instance-one
proxy_read_timeout 90;
- proxy_redirect http://127.0.0.1:8080 https://trilium.example.net; # change them based on your IP, port and domain
}
config.ini
:[General]
noAuthentication=true
Disabling authentication will bypass even the Multi-Factor Authentication since + href="#root/_help_7DAiwaf8Z7Rz">Multi-Factor Authentication since v0.94.1.
Once logged into Trilium, the application will store this information @@ -22,14 +22,14 @@ cookieMaxAge=86400 the last interaction with the application.
The login sessions are now stored in the same Database as - the user data. In order to view which sessions are active, open the - SQL Console and run the following query:
SELECT * FROM sessions
+ href="#root/_help_wX4HbRucYSDD">Database as the user data. In
+ order to view which sessions are active, open the SQL Console and run the following
+ query:SELECT * FROM sessions
Expired sessions are periodically cleaned by the server, generally an hourly interval.
In order to setup OpenID, you will need to setup a authentication provider. This requires a bit of extra setup. Follow these instructions to setup an OpenID service through google.
@@ -61,4 +57,12 @@ class="admonition warning">Currently the only way to include a custom font is to use Custom resource providers.
Basically import a font into Trilium and assign it #customResourceProvider=fonts/myfont.ttf
and
- then import the font in CSS via /custom/fonts/myfont.ttf
.
/custom/fonts/myfont.ttf
. Use ../../../custom/fonts/myfont.ttf
if
+ you run your Trilium server on a different path than /
.
A light theme needs to have the following CSS:
:root {
--theme-style: light;
diff --git a/docs/Developer Guide/!!!meta.json b/docs/Developer Guide/!!!meta.json
index 6e9c247b9..38f1e2c47 100644
--- a/docs/Developer Guide/!!!meta.json
+++ b/docs/Developer Guide/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.94.0",
+ "appVersion": "0.94.1",
"files": [
{
"isClone": false,
diff --git a/docs/Release Notes/!!!meta.json b/docs/Release Notes/!!!meta.json
index 1c30ae90c..3fed9ee6b 100644
--- a/docs/Release Notes/!!!meta.json
+++ b/docs/Release Notes/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.94.0",
+ "appVersion": "0.94.1",
"files": [
{
"isClone": false,
diff --git a/docs/Release Notes/Release Notes/v0.94.1.md b/docs/Release Notes/Release Notes/v0.94.1.md
index 7a630ccab..0dc2be481 100644
--- a/docs/Release Notes/Release Notes/v0.94.1.md
+++ b/docs/Release Notes/Release Notes/v0.94.1.md
@@ -1,6 +1,6 @@
# v0.94.1
> [!NOTE]
-> *TriliumNext Notes* will rebrand itself back to Trilium Notes since @zadam was kind enough to give us the original name. See [#2190](https://github.com/orgs/TriliumNext/discussions/2190) for more info. This will probably be the "last" version branded as *TriliumNext Notes*.
+> _TriliumNext Notes_ will rebrand itself back to Trilium Notes since @zadam was kind enough to give us the original name. See [#2190](https://github.com/orgs/TriliumNext/discussions/2190) for more info. This will probably be the "last" version branded as _TriliumNext Notes_.
> [!IMPORTANT]
> If you enjoyed this release, consider showing a token of appreciation by:
diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json
index 82f5f1f1e..aba2495dc 100644
--- a/docs/User Guide/!!!meta.json
+++ b/docs/User Guide/!!!meta.json
@@ -1,6 +1,6 @@
{
"formatVersion": 2,
- "appVersion": "0.94.0",
+ "appVersion": "0.94.1",
"files": [
{
"isClone": false,
@@ -189,23 +189,23 @@
{
"type": "relation",
"name": "internalLink",
- "value": "fDLvzOx29Pfg",
+ "value": "0hzsNCP31IAB",
"isInheritable": false,
"position": 120
},
+ {
+ "type": "relation",
+ "name": "internalLink",
+ "value": "fDLvzOx29Pfg",
+ "isInheritable": false,
+ "position": 130
+ },
{
"type": "label",
"name": "shareAlias",
"value": "server-installation",
"isInheritable": false,
"position": 30
- },
- {
- "type": "relation",
- "name": "internalLink",
- "value": "0hzsNCP31IAB",
- "isInheritable": false,
- "position": 130
}
],
"format": "markdown",
@@ -674,32 +674,32 @@
"mime": "text/html",
"attributes": [
{
- "type": "label",
- "name": "iconClass",
- "value": "bx bx-lock-alt",
+ "type": "relation",
+ "name": "internalLink",
+ "value": "wX4HbRucYSDD",
"isInheritable": false,
"position": 10
},
{
"type": "relation",
"name": "internalLink",
- "value": "7DAiwaf8Z7Rz",
+ "value": "YKWqdJhzi2VY",
"isInheritable": false,
"position": 20
},
{
"type": "relation",
"name": "internalLink",
- "value": "wX4HbRucYSDD",
+ "value": "7DAiwaf8Z7Rz",
"isInheritable": false,
"position": 30
},
{
- "type": "relation",
- "name": "internalLink",
- "value": "YKWqdJhzi2VY",
+ "type": "label",
+ "name": "iconClass",
+ "value": "bx bx-lock-alt",
"isInheritable": false,
- "position": 40
+ "position": 10
}
],
"format": "markdown",
diff --git a/docs/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.md b/docs/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.md
index 24b57c4ea..57f51b4e6 100644
--- a/docs/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.md
+++ b/docs/User Guide/User Guide/Installation & Setup/Server Installation/2. Reverse proxy/Nginx.md
@@ -73,4 +73,4 @@ Configure Nginx proxy and HTTPS. The operating system here is Ubuntu 18.04.
proxy_read_timeout 90;
}
- ```
+ ```
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Installation & Setup/Server Installation/Authentication.md b/docs/User Guide/User Guide/Installation & Setup/Server Installation/Authentication.md
index 901127eb7..cebac2f48 100644
--- a/docs/User Guide/User Guide/Installation & Setup/Server Installation/Authentication.md
+++ b/docs/User Guide/User Guide/Installation & Setup/Server Installation/Authentication.md
@@ -27,7 +27,7 @@ When “Remember me” is unchecked, the behavior is different. At client/browse
The login sessions are now stored in the same Database as the user data. In order to view which sessions are active, open the SQL Console and run the following query:
-```trilium
+```
SELECT * FROM sessions
```
diff --git a/docs/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.md b/docs/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.md
index a2bf3f7e4..e76e1e2c2 100644
--- a/docs/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.md
+++ b/docs/User Guide/User Guide/Installation & Setup/Server Installation/Multi-Factor Authentication.md
@@ -34,9 +34,6 @@ MFA can only be set up on a server instance.
### OpenID
-> [!NOTE]
-> Currently only compatible with Google. Other services like Authentik and Auth0 are planned on being added.
-
In order to setup OpenID, you will need to setup a authentication provider. This requires a bit of extra setup. Follow [these instructions](https://developers.google.com/identity/openid-connect/openid-connect) to setup an OpenID service through google.
1. Set the `oauthBaseUrl`, `oauthClientId` and `oauthClientSecret` in the `config.ini` file (check Configuration (config.ini or environment variables) for more information).
@@ -45,4 +42,7 @@ In order to setup OpenID, you will need to setup a authentication provider. This
3. Go to "Menu" -> "Options" -> "MFA"
4. Click the “Enable Multi-Factor Authentication” checkbox if not checked
5. Choose “OAuth/OpenID” under MFA Method
-6. Refresh the page and login through OpenID provider
\ No newline at end of file
+6. Refresh the page and login through OpenID provider
+
+> [!NOTE]
+> The default OAuth issuer is Google. To use other services such as Authentik or Auth0, you can configure the settings via `oauthIssuerBaseUrl`, `oauthIssuerName`, and `oauthIssuerIcon` in the `config.ini` file. Alternatively, these values can be set using environment variables: `TRILIUM_OAUTH_ISSUER_BASE_URL`, `TRILIUM_OAUTH_ISSUER_NAME`, and `TRILIUM_OAUTH_ISSUER_ICON`. `oauthIssuerName` and `oauthIssuerIcon` are required for displaying correct issuer information at the Login page.
\ No newline at end of file
diff --git a/docs/User Guide/User Guide/Theme development/Reference.md b/docs/User Guide/User Guide/Theme development/Reference.md
index 5e1036ae1..9f1be7b9c 100644
--- a/docs/User Guide/User Guide/Theme development/Reference.md
+++ b/docs/User Guide/User Guide/Theme development/Reference.md
@@ -195,4 +195,4 @@ If the theme is auto (e.g. supports both light or dark based on `prefers-color-s
}
```
-This will affect the behavior of the Electron application by informing the operating system of the color preference (e.g. background effects will appear correct on Windows).
+This will affect the behavior of the Electron application by informing the operating system of the color preference (e.g. background effects will appear correct on Windows).
\ No newline at end of file