Multi-Factor Authentication

Multi-factor authentication (MFA) is a security process that requires users to provide two or more verification factors to gain access to a system, application, or account. This adds an extra layer of protection beyond just using a password.

By requiring more than one verification method, MFA helps reduce the risk of unauthorized access, even if someone has obtained your password. It’s highly recommended for securing sensitive information stored in your notes.

Warning

OpenID and TOTP cannot be both used at the same time!

Log in with your Google Account with OpenID!

OpenID is a standardized way to let you log into websites using an account from another service, like Google, to verify your identity.

Why Time-based One Time Passwords?

TOTP (Time-Based One-Time Password) is a security feature that generates a unique, temporary code on your device, like a smartphone, which changes every 30 seconds. You use this code, along with your password, to log into your account, making it much harder for anyone else to access them.

Setup

MFA can only be set up on a server instance.

Note

When Multi-Factor Authentication (MFA) is enabled on a server instance, a new desktop instance may fail to sync with it. As a temporary workaround, you can disable MFA to complete the initial sync, then re-enable MFA afterward. This issue will be addressed in a future release.

TOTP

Go to "Menu" -> "Options" -> "MFA"
Click the “Enable Multi-Factor Authentication” checkbox if not checked
Choose “Time-Based One-Time Password (TOTP)” under MFA Method
Click the "Generate TOTP Secret" button
Copy the generated secret to your authentication app/extension
Click the "Generate Recovery Codes" button
Save the recovery codes. Recovery codes can be used once in place of the TOTP if you loose access to your authenticator. After a rerecovery code is used, it will show the unix timestamp when it was used in the MFA options tab.
Re-login will be required after TOTP setup is finished (After you refreshing the page).

OpenID

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.

Set the oauthBaseUrl, oauthClientId and oauthClientSecret in the config.ini file (check Configuration (config.ini or environment variables) for more information).
1. You can also setup through environment variables (TRILIUM_OAUTH_BASE_URL, TRILIUM_OAUTH_CLIENT_ID and TRILIUM_OAUTH_CLIENT_SECRET).
Restart the server
Go to "Menu" -> "Options" -> "MFA"
Click the “Enable Multi-Factor Authentication” checkbox if not checked
Choose “OAuth/OpenID” under MFA Method
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.

3.5 KiB Vendored Raw Blame History Unescape Escape