mirror of
https://github.com/zadam/trilium.git
synced 2025-11-01 02:45:54 +01:00
docs: ✏️ Add custom OAuth issuer docs
This commit is contained in:
36
docs/User Guide/!!!meta.json
vendored
36
docs/User Guide/!!!meta.json
vendored
@@ -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",
|
||||
|
||||
@@ -73,4 +73,4 @@ Configure Nginx proxy and HTTPS. The operating system here is Ubuntu 18.04.
|
||||
proxy_read_timeout 90;
|
||||
}
|
||||
|
||||
```
|
||||
```
|
||||
@@ -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 <a class="reference-link" href="../../Advanced%20Usage/Database.md">Database</a> as the user data. In order to view which sessions are active, open the <a class="reference-link" href="../../Advanced%20Usage/Database/Manually%20altering%20the%20database/SQL%20Console.md">SQL Console</a> and run the following query:
|
||||
|
||||
```trilium
|
||||
```
|
||||
SELECT * FROM sessions
|
||||
```
|
||||
|
||||
|
||||
@@ -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 <a class="reference-link" href="../../Advanced%20Usage/Configuration%20(config.ini%20or%20e.md">Configuration (config.ini or environment variables)</a> 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
|
||||
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.
|
||||
@@ -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).
|
||||
Reference in New Issue
Block a user