Reference
Settings
Admin
Set by an admin in Settings, under the plugin's name. It applies to everyone.
| Setting | Type | Default | What it does |
|---|---|---|---|
| Sign in with SSO automatically | boolean | false | Send visitors straight to the first SSO provider instead of showing the login form. The OIDC_SILENT_LOGIN_DEFAULT environment variable overrides this. |
| Let users link their account | boolean | true | Users can link a single sign-on account to their Termix account in Settings, Security. Off, only admins can link accounts. |
Environment variables
Set these on the Termix server, for example under environment: in your compose file. See environment variables for the ones core and other plugins read.
| Variable | Default | What it does |
|---|---|---|
OIDC_CLIENT_ID | Client ID of an OIDC provider set from the environment. Needs the next four too. | |
OIDC_CLIENT_SECRET | Its client secret. | |
OIDC_ISSUER_URL | Its issuer URL. | |
OIDC_AUTHORIZATION_URL | Its authorization endpoint. | |
OIDC_TOKEN_URL | Its token endpoint. | |
OIDC_USERINFO_URL | Its userinfo endpoint, if it is not the usual one. | |
OIDC_IDENTIFIER_PATH | sub | Claim that identifies a user. |
OIDC_NAME_PATH | preferred_username | Claim used as the Termix username. |
OIDC_SCOPES | openid email profile | Scopes to ask for. |
OIDC_ALLOWED_USERS | Emails allowed to sign in, comma separated. Empty allows everyone. | |
OIDC_ADMIN_GROUP | Members of this group are admins. | |
OIDC_GROUP_CLAIM | Claim with the groups, if not groups, roles or group. | |
OIDC_ROLE_MAP | Groups to Termix roles as group:role pairs, comma separated. Works for every OIDC provider, not just this one. | |
OIDC_SIGN_OUT_AT_PROVIDER | false | true also signs people out of the provider above when they sign out of Termix. |
OIDC_END_SESSION_URL | The provider's sign out page, if it is not in its discovery document. | |
OIDC_ENV_OVERRIDE | false | true makes the provider above the only one, even when providers are set up in the app. |
OIDC_LEGACY_CALLBACK | true | false makes the provider above send the new redirect URI, /plugin-api/sso/callback, instead of the 2.8 one, /users/oidc/callback. |
OIDC_SILENT_LOGIN_DEFAULT | true or false. Sends visitors straight to SSO, and locks the setting. |
Permissions
Give these to roles in Settings, Roles.
| Permission | Who has it at first | What it allows |
|---|---|---|
sso.manage | admin | Add, change and remove the SSO providers people can sign in with. |
Capabilities
What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.
| Capability | Risk | What it means |
|---|---|---|
auth:provide | High | Handle sign in. It can add a login method, a second factor or an SSH sign-in type. |
network:serve | Medium | Accept connections. It opens a port on the Termix server. |
network:outbound | Medium | Reach the internet. It can send requests to outside services. |
db:own | Low | Store its own data. Kept in its own tables, separate from other plugins. |
kv:own | Low | Remember small settings. Kept separate from other plugins. |
secrets:own | Low | Store its own secrets. Encrypted by Termix. The plugin never holds the key. |
ui:surface | Low | Add its own screens. Tabs, panels and settings you can hide later. |
API
The plugin's HTTP routes are in the API reference.
Platforms
Linux, Windows, macOS