Configuration
Tinyauth can be configured using environment variables or CLI flags. The table below provides a comprehensive list of configuration options.
Configuration
Section titled “Configuration”main
| Option | Description | Default |
|---|---|---|
TINYAUTH_APPURL |
The base URL where the app is hosted. | `` |
TINYAUTH_CONFIGFILE |
Path to config file. | `` |
TINYAUTH_LABELPROVIDER |
Label provider to use for ACLs (auto, docker, kubernetes or none to disable). auto detects the environment. | auto |
database
| Option | Description | Default |
|---|---|---|
TINYAUTH_DATABASE_DRIVER |
The database driver to use. Valid values: sqlite, postgres, memory. | sqlite |
TINYAUTH_DATABASE_PATH |
The path to the SQLite database file, or connection URL when driver is postgres. | ./tinyauth.db |
analytics
| Option | Description | Default |
|---|---|---|
TINYAUTH_ANALYTICS_ENABLED |
Enable periodic version information collection. | true |
resources
| Option | Description | Default |
|---|---|---|
TINYAUTH_RESOURCES_ENABLED |
Enable the resources server. | true |
TINYAUTH_RESOURCES_PATH |
The directory where resources are stored. | ./resources |
server
| Option | Description | Default |
|---|---|---|
TINYAUTH_SERVER_PORT |
The port on which the server listens. | 3000 |
TINYAUTH_SERVER_ADDRESS |
The address on which the server listens. | 0.0.0.0 |
TINYAUTH_SERVER_SOCKETPATH |
The path to the Unix socket. | `` |
auth
| Option | Description | Default |
|---|---|---|
TINYAUTH_AUTH_IP_ALLOW |
List of allowed IPs or CIDR ranges. | `` |
TINYAUTH_AUTH_IP_BLOCK |
List of blocked IPs or CIDR ranges. | `` |
TINYAUTH_AUTH_IP_BYPASS |
List of IPs or CIDR ranges that bypass authentication entirely. | `` |
TINYAUTH_AUTH_USERS |
Comma-separated list of users (username:hashed_password). | `` |
TINYAUTH_AUTH_SUBDOMAINSENABLED |
Enable subdomains support. | true |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_NAME |
Full name of the user. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_GIVENNAME |
Given (first) name of the user. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_FAMILYNAME |
Family (last) name of the user. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_MIDDLENAME |
Middle name of the user. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_NICKNAME |
Nickname of the user. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_PROFILE |
URL of the user’s profile page. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_PICTURE |
URL of the user’s profile picture. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_WEBSITE |
URL of the user’s website. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_EMAIL |
Email address of the user. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_GENDER |
Gender of the user. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_BIRTHDATE |
Birthdate of the user (YYYY-MM-DD). | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_ZONEINFO |
Time zone of the user (e.g. Europe/Athens). | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_LOCALE |
Locale of the user (e.g. en-US). | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_PHONENUMBER |
Phone number of the user. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_ADDRESS_FORMATTED |
Full mailing address, formatted for display. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_ADDRESS_STREETADDRESS |
Street address. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_ADDRESS_LOCALITY |
City or locality. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_ADDRESS_REGION |
State, province, or region. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_ADDRESS_POSTALCODE |
Zip or postal code. | `` |
TINYAUTH_AUTH_USERATTRIBUTES_[NAME]_ADDRESS_COUNTRY |
Country. | `` |
TINYAUTH_AUTH_USERSFILE |
Path to the users file. | `` |
TINYAUTH_AUTH_SECURECOOKIE |
Enable secure cookies. | false |
TINYAUTH_AUTH_SESSIONEXPIRY |
Session expiry time in seconds. | 86400 |
TINYAUTH_AUTH_SESSIONMAXLIFETIME |
Maximum session lifetime in seconds. | 0 |
TINYAUTH_AUTH_LOGINTIMEOUT |
Login timeout in seconds. | 300 |
TINYAUTH_AUTH_LOGINMAXRETRIES |
Maximum login retries. | 3 |
TINYAUTH_AUTH_TRUSTEDPROXIES |
Comma-separated list of trusted proxy addresses. | `` |
TINYAUTH_AUTH_ACLS_POLICY |
ACL policy for allow-by-default or deny-by-default, available options are allow and deny, default is allow. | allow |
apps
| Option | Description | Default |
|---|---|---|
TINYAUTH_APPS_[NAME]_CONFIG_DOMAIN |
The domain of the app. | `` |
TINYAUTH_APPS_[NAME]_USERS_ALLOW |
Comma-separated list of allowed users. | `` |
TINYAUTH_APPS_[NAME]_USERS_BLOCK |
Comma-separated list of blocked users. | `` |
TINYAUTH_APPS_[NAME]_OAUTH_WHITELIST |
Comma-separated list of allowed OAuth groups. | `` |
TINYAUTH_APPS_[NAME]_OAUTH_GROUPS |
Comma-separated list of required OAuth groups. | `` |
TINYAUTH_APPS_[NAME]_IP_ALLOW |
List of allowed IPs or CIDR ranges. | `` |
TINYAUTH_APPS_[NAME]_IP_BLOCK |
List of blocked IPs or CIDR ranges. | `` |
TINYAUTH_APPS_[NAME]_IP_BYPASS |
List of IPs or CIDR ranges that bypass authentication. | `` |
TINYAUTH_APPS_[NAME]_RESPONSE_HEADERS |
Custom headers to add to the response. | `` |
TINYAUTH_APPS_[NAME]_RESPONSE_BASICAUTH_USERNAME |
Basic auth username. | `` |
TINYAUTH_APPS_[NAME]_RESPONSE_BASICAUTH_PASSWORD |
Basic auth password. | `` |
TINYAUTH_APPS_[NAME]_RESPONSE_BASICAUTH_PASSWORDFILE |
Path to the file containing the basic auth password. | `` |
TINYAUTH_APPS_[NAME]_PATH_ALLOW |
Disable authentication for only paths that match the regex string. | `` |
TINYAUTH_APPS_[NAME]_PATH_BLOCK |
Enable authentication for only paths that match the regex string. | `` |
TINYAUTH_APPS_[NAME]_LDAP_GROUPS |
Comma-separated list of required LDAP groups. | `` |
oauth
| Option | Description | Default |
|---|---|---|
TINYAUTH_OAUTH_WHITELIST |
Comma-separated list of allowed OAuth domains. | `` |
TINYAUTH_OAUTH_WHITELISTFILE |
Path to the OAuth whitelist file. | `` |
TINYAUTH_OAUTH_AUTOREDIRECT |
The OAuth provider to use for automatic redirection. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_CLIENTID |
OAuth client ID. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_CLIENTSECRET |
OAuth client secret. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_CLIENTSECRETFILE |
Path to the file containing the OAuth client secret. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_WHITELIST |
Comma-separated list of allowed OAuth domains for this provider. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_WHITELISTFILE |
Path to the OAuth whitelist file for this provider. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_SCOPES |
OAuth scopes. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_REDIRECTURL |
OAuth redirect URL. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_AUTHURL |
OAuth authorization URL. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_TOKENURL |
OAuth token URL. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_USERINFOURL |
OAuth userinfo URL. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_INSECURE |
Allow insecure OAuth connections. | false |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_NAME |
Provider name in UI. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_CLAIMS_USERNAME |
Username claim. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_CLAIMS_EMAIL |
Email claim. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_CLAIMS_NAME |
Name claim. | `` |
TINYAUTH_OAUTH_PROVIDERS_[NAME]_CLAIMS_GROUPS |
Groups claim. | `` |
oidc
| Option | Description | Default |
|---|---|---|
TINYAUTH_OIDC_PRIVATEKEYPATH |
Path to the private key file, including file name. | ./tinyauth_oidc_key |
TINYAUTH_OIDC_PUBLICKEYPATH |
Path to the public key file, including file name. | ./tinyauth_oidc_key.pub |
TINYAUTH_OIDC_CLIENTS_[NAME]_CLIENTID |
OIDC client ID. | `` |
TINYAUTH_OIDC_CLIENTS_[NAME]_CLIENTSECRET |
OIDC client secret. | `` |
TINYAUTH_OIDC_CLIENTS_[NAME]_CLIENTSECRETFILE |
Path to the file containing the OIDC client secret. | `` |
TINYAUTH_OIDC_CLIENTS_[NAME]_TRUSTEDREDIRECTURIS |
List of trusted redirect URIs. | `` |
TINYAUTH_OIDC_CLIENTS_[NAME]_NAME |
Client name in UI. | `` |
ui
| Option | Description | Default |
|---|---|---|
TINYAUTH_UI_TITLE |
The title of the UI. | Tinyauth |
TINYAUTH_UI_FORGOTPASSWORDMESSAGE |
Message displayed on the forgot password page. | You can change your password by changing the configuration. |
TINYAUTH_UI_BACKGROUNDIMAGE |
Path to the background image. | /background.webp |
TINYAUTH_UI_WARNINGSENABLED |
Enable UI warnings. | true |
ldap
| Option | Description | Default |
|---|---|---|
TINYAUTH_LDAP_ADDRESS |
LDAP server address. | `` |
TINYAUTH_LDAP_BINDDN |
Bind DN for LDAP authentication. | `` |
TINYAUTH_LDAP_BINDPASSWORD |
Bind password for LDAP authentication. | `` |
TINYAUTH_LDAP_BINDPASSWORDFILE |
Path to the Bind password. | `` |
TINYAUTH_LDAP_BASEDN |
Base DN for LDAP searches. | `` |
TINYAUTH_LDAP_INSECURE |
Allow insecure LDAP connections. | false |
TINYAUTH_LDAP_SEARCHFILTER |
LDAP search filter. | (uid=%s) |
TINYAUTH_LDAP_AUTHCERT |
Certificate for mTLS authentication. | `` |
TINYAUTH_LDAP_AUTHKEY |
Certificate key for mTLS authentication. | `` |
TINYAUTH_LDAP_GROUPCACHETTL |
Cache duration for LDAP group membership in seconds. | 900 |
experimental
| Option | Description | Default |
|---|---|---|
TINYAUTH_EXPERIMENTAL_OAUTHBRIDGEENABLED |
Enable the OAuth bridge, uses a new way to format OAuth user information. | false |
TINYAUTH_EXPERIMENTAL_DISABLEAUTHMODULEFALLBACK |
Disable the fallback to forward_auth modules when auth_request or ext_authz fail. | false |
tailscale
| Option | Description | Default |
|---|---|---|
TINYAUTH_TAILSCALE_ENABLED |
Enable Tailscale integration. | false |
TINYAUTH_TAILSCALE_APITOKEN |
Tailscale API token. | `` |
TINYAUTH_TAILSCALE_APITOKENFILE |
Path to the file containing the Tailscale API token. | `` |
TINYAUTH_TAILSCALE_TAILNET |
Tailnet name. | `` |
TINYAUTH_TAILSCALE_CACHEDURATION |
Cache duration for Tailscale device and user lists in seconds. | 300 |
log
| Option | Description | Default |
|---|---|---|
TINYAUTH_LOG_LEVEL |
Log level (trace, debug, info, warn, error). | info |
TINYAUTH_LOG_JSON |
Enable JSON formatted logs. | false |
TINYAUTH_LOG_STREAMS_HTTP_ENABLED |
Enable this log stream. | true |
TINYAUTH_LOG_STREAMS_HTTP_LEVEL |
Log level for this stream. Use global if empty. | `` |
TINYAUTH_LOG_STREAMS_APP_ENABLED |
Enable this log stream. | true |
TINYAUTH_LOG_STREAMS_APP_LEVEL |
Log level for this stream. Use global if empty. | `` |
TINYAUTH_LOG_STREAMS_AUDIT_ENABLED |
Enable this log stream. | false |
TINYAUTH_LOG_STREAMS_AUDIT_LEVEL |
Log level for this stream. Use global if empty. | `` |
main
| Option | Description | Default |
|---|---|---|
--appurl |
The base URL where the app is hosted. | `` |
--configfile |
Path to config file. | `` |
--labelprovider |
Label provider to use for ACLs (auto, docker, kubernetes or none to disable). auto detects the environment. | auto |
database
| Option | Description | Default |
|---|---|---|
--database.driver |
The database driver to use. Valid values: sqlite, postgres, memory. | sqlite |
--database.path |
The path to the SQLite database file, or connection URL when driver is postgres. | ./tinyauth.db |
analytics
| Option | Description | Default |
|---|---|---|
--analytics.enabled |
Enable periodic version information collection. | true |
resources
| Option | Description | Default |
|---|---|---|
--resources.enabled |
Enable the resources server. | true |
--resources.path |
The directory where resources are stored. | ./resources |
server
| Option | Description | Default |
|---|---|---|
--server.port |
The port on which the server listens. | 3000 |
--server.address |
The address on which the server listens. | 0.0.0.0 |
--server.socketpath |
The path to the Unix socket. | `` |
auth
| Option | Description | Default |
|---|---|---|
--auth.ip.allow |
List of allowed IPs or CIDR ranges. | `` |
--auth.ip.block |
List of blocked IPs or CIDR ranges. | `` |
--auth.ip.bypass |
List of IPs or CIDR ranges that bypass authentication entirely. | `` |
--auth.users |
Comma-separated list of users (username:hashed_password). | `` |
--auth.subdomainsenabled |
Enable subdomains support. | true |
--auth.userAttributes.[name].name |
Full name of the user. | `` |
--auth.userAttributes.[name].givenname |
Given (first) name of the user. | `` |
--auth.userAttributes.[name].familyname |
Family (last) name of the user. | `` |
--auth.userAttributes.[name].middlename |
Middle name of the user. | `` |
--auth.userAttributes.[name].nickname |
Nickname of the user. | `` |
--auth.userAttributes.[name].profile |
URL of the user’s profile page. | `` |
--auth.userAttributes.[name].picture |
URL of the user’s profile picture. | `` |
--auth.userAttributes.[name].website |
URL of the user’s website. | `` |
--auth.userAttributes.[name].email |
Email address of the user. | `` |
--auth.userAttributes.[name].gender |
Gender of the user. | `` |
--auth.userAttributes.[name].birthdate |
Birthdate of the user (YYYY-MM-DD). | `` |
--auth.userAttributes.[name].zoneinfo |
Time zone of the user (e.g. Europe/Athens). | `` |
--auth.userAttributes.[name].locale |
Locale of the user (e.g. en-US). | `` |
--auth.userAttributes.[name].phonenumber |
Phone number of the user. | `` |
--auth.userAttributes.[name].address.formatted |
Full mailing address, formatted for display. | `` |
--auth.userAttributes.[name].address.streetaddress |
Street address. | `` |
--auth.userAttributes.[name].address.locality |
City or locality. | `` |
--auth.userAttributes.[name].address.region |
State, province, or region. | `` |
--auth.userAttributes.[name].address.postalcode |
Zip or postal code. | `` |
--auth.userAttributes.[name].address.country |
Country. | `` |
--auth.usersfile |
Path to the users file. | `` |
--auth.securecookie |
Enable secure cookies. | false |
--auth.sessionexpiry |
Session expiry time in seconds. | 86400 |
--auth.sessionmaxlifetime |
Maximum session lifetime in seconds. | 0 |
--auth.logintimeout |
Login timeout in seconds. | 300 |
--auth.loginmaxretries |
Maximum login retries. | 3 |
--auth.trustedproxies |
Comma-separated list of trusted proxy addresses. | `` |
--auth.acls.policy |
ACL policy for allow-by-default or deny-by-default, available options are allow and deny, default is allow. | allow |
apps
| Option | Description | Default |
|---|---|---|
--apps.[name].config.domain |
The domain of the app. | `` |
--apps.[name].users.allow |
Comma-separated list of allowed users. | `` |
--apps.[name].users.block |
Comma-separated list of blocked users. | `` |
--apps.[name].oauth.whitelist |
Comma-separated list of allowed OAuth groups. | `` |
--apps.[name].oauth.groups |
Comma-separated list of required OAuth groups. | `` |
--apps.[name].ip.allow |
List of allowed IPs or CIDR ranges. | `` |
--apps.[name].ip.block |
List of blocked IPs or CIDR ranges. | `` |
--apps.[name].ip.bypass |
List of IPs or CIDR ranges that bypass authentication. | `` |
--apps.[name].response.headers |
Custom headers to add to the response. | `` |
--apps.[name].response.basicauth.username |
Basic auth username. | `` |
--apps.[name].response.basicauth.password |
Basic auth password. | `` |
--apps.[name].response.basicauth.passwordfile |
Path to the file containing the basic auth password. | `` |
--apps.[name].path.allow |
Disable authentication for only paths that match the regex string. | `` |
--apps.[name].path.block |
Enable authentication for only paths that match the regex string. | `` |
--apps.[name].ldap.groups |
Comma-separated list of required LDAP groups. | `` |
oauth
| Option | Description | Default |
|---|---|---|
--oauth.whitelist |
Comma-separated list of allowed OAuth domains. | `` |
--oauth.whitelistfile |
Path to the OAuth whitelist file. | `` |
--oauth.autoredirect |
The OAuth provider to use for automatic redirection. | `` |
--oauth.providers.[name].clientid |
OAuth client ID. | `` |
--oauth.providers.[name].clientsecret |
OAuth client secret. | `` |
--oauth.providers.[name].clientsecretfile |
Path to the file containing the OAuth client secret. | `` |
--oauth.providers.[name].whitelist |
Comma-separated list of allowed OAuth domains for this provider. | `` |
--oauth.providers.[name].whitelistfile |
Path to the OAuth whitelist file for this provider. | `` |
--oauth.providers.[name].scopes |
OAuth scopes. | `` |
--oauth.providers.[name].redirecturl |
OAuth redirect URL. | `` |
--oauth.providers.[name].authurl |
OAuth authorization URL. | `` |
--oauth.providers.[name].tokenurl |
OAuth token URL. | `` |
--oauth.providers.[name].userinfourl |
OAuth userinfo URL. | `` |
--oauth.providers.[name].insecure |
Allow insecure OAuth connections. | false |
--oauth.providers.[name].name |
Provider name in UI. | `` |
--oauth.providers.[name].claims.username |
Username claim. | `` |
--oauth.providers.[name].claims.email |
Email claim. | `` |
--oauth.providers.[name].claims.name |
Name claim. | `` |
--oauth.providers.[name].claims.groups |
Groups claim. | `` |
oidc
| Option | Description | Default |
|---|---|---|
--oidc.privatekeypath |
Path to the private key file, including file name. | ./tinyauth_oidc_key |
--oidc.publickeypath |
Path to the public key file, including file name. | ./tinyauth_oidc_key.pub |
--oidc.clients.[name].clientid |
OIDC client ID. | `` |
--oidc.clients.[name].clientsecret |
OIDC client secret. | `` |
--oidc.clients.[name].clientsecretfile |
Path to the file containing the OIDC client secret. | `` |
--oidc.clients.[name].trustedredirecturis |
List of trusted redirect URIs. | `` |
--oidc.clients.[name].name |
Client name in UI. | `` |
ui
| Option | Description | Default |
|---|---|---|
--ui.title |
The title of the UI. | Tinyauth |
--ui.forgotpasswordmessage |
Message displayed on the forgot password page. | You can change your password by changing the configuration. |
--ui.backgroundimage |
Path to the background image. | /background.webp |
--ui.warningsenabled |
Enable UI warnings. | true |
ldap
| Option | Description | Default |
|---|---|---|
--ldap.address |
LDAP server address. | `` |
--ldap.binddn |
Bind DN for LDAP authentication. | `` |
--ldap.bindpassword |
Bind password for LDAP authentication. | `` |
--ldap.bindpasswordfile |
Path to the Bind password. | `` |
--ldap.basedn |
Base DN for LDAP searches. | `` |
--ldap.insecure |
Allow insecure LDAP connections. | false |
--ldap.searchfilter |
LDAP search filter. | (uid=%s) |
--ldap.authcert |
Certificate for mTLS authentication. | `` |
--ldap.authkey |
Certificate key for mTLS authentication. | `` |
--ldap.groupcachettl |
Cache duration for LDAP group membership in seconds. | 900 |
experimental
| Option | Description | Default |
|---|---|---|
--experimental.oauthbridgeenabled |
Enable the OAuth bridge, uses a new way to format OAuth user information. | false |
--experimental.disableauthmodulefallback |
Disable the fallback to forward_auth modules when auth_request or ext_authz fail. | false |
tailscale
| Option | Description | Default |
|---|---|---|
--tailscale.enabled |
Enable Tailscale integration. | false |
--tailscale.apitoken |
Tailscale API token. | `` |
--tailscale.apitokenfile |
Path to the file containing the Tailscale API token. | `` |
--tailscale.tailnet |
Tailnet name. | `` |
--tailscale.cacheduration |
Cache duration for Tailscale device and user lists in seconds. | 300 |
log
| Option | Description | Default |
|---|---|---|
--log.level |
Log level (trace, debug, info, warn, error). | info |
--log.json |
Enable JSON formatted logs. | false |
--log.streams.http.enabled |
Enable this log stream. | true |
--log.streams.http.level |
Log level for this stream. Use global if empty. | `` |
--log.streams.app.enabled |
Enable this log stream. | true |
--log.streams.app.level |
Log level for this stream. Use global if empty. | `` |
--log.streams.audit.enabled |
Enable this log stream. | false |
--log.streams.audit.level |
Log level for this stream. Use global if empty. | `` |
main
| Option | Description | Default |
|---|---|---|
appUrl |
The base URL where the app is hosted. | `` |
labelProvider |
Label provider to use for ACLs (auto, docker, kubernetes or none to disable). auto detects the environment. | auto |
database
| Option | Description | Default |
|---|---|---|
database.driver |
The database driver to use. Valid values: sqlite, postgres, memory. | sqlite |
database.path |
The path to the SQLite database file, or connection URL when driver is postgres. | ./tinyauth.db |
analytics
| Option | Description | Default |
|---|---|---|
analytics.enabled |
Enable periodic version information collection. | true |
resources
| Option | Description | Default |
|---|---|---|
resources.enabled |
Enable the resources server. | true |
resources.path |
The directory where resources are stored. | ./resources |
server
| Option | Description | Default |
|---|---|---|
server.port |
The port on which the server listens. | 3000 |
server.address |
The address on which the server listens. | 0.0.0.0 |
server.socketPath |
The path to the Unix socket. | `` |
auth
| Option | Description | Default |
|---|---|---|
auth.ip.allow |
List of allowed IPs or CIDR ranges. | `` |
auth.ip.block |
List of blocked IPs or CIDR ranges. | `` |
auth.ip.bypass |
List of IPs or CIDR ranges that bypass authentication entirely. | `` |
auth.users |
Comma-separated list of users (username:hashed_password). | `` |
auth.subdomainsEnabled |
Enable subdomains support. | true |
auth.userAttributes.[name].name |
Full name of the user. | `` |
auth.userAttributes.[name].givenName |
Given (first) name of the user. | `` |
auth.userAttributes.[name].familyName |
Family (last) name of the user. | `` |
auth.userAttributes.[name].middleName |
Middle name of the user. | `` |
auth.userAttributes.[name].nickname |
Nickname of the user. | `` |
auth.userAttributes.[name].profile |
URL of the user’s profile page. | `` |
auth.userAttributes.[name].picture |
URL of the user’s profile picture. | `` |
auth.userAttributes.[name].website |
URL of the user’s website. | `` |
auth.userAttributes.[name].email |
Email address of the user. | `` |
auth.userAttributes.[name].gender |
Gender of the user. | `` |
auth.userAttributes.[name].birthdate |
Birthdate of the user (YYYY-MM-DD). | `` |
auth.userAttributes.[name].zoneinfo |
Time zone of the user (e.g. Europe/Athens). | `` |
auth.userAttributes.[name].locale |
Locale of the user (e.g. en-US). | `` |
auth.userAttributes.[name].phoneNumber |
Phone number of the user. | `` |
auth.userAttributes.[name].address.formatted |
Full mailing address, formatted for display. | `` |
auth.userAttributes.[name].address.streetAddress |
Street address. | `` |
auth.userAttributes.[name].address.locality |
City or locality. | `` |
auth.userAttributes.[name].address.region |
State, province, or region. | `` |
auth.userAttributes.[name].address.postalCode |
Zip or postal code. | `` |
auth.userAttributes.[name].address.country |
Country. | `` |
auth.usersFile |
Path to the users file. | `` |
auth.secureCookie |
Enable secure cookies. | false |
auth.sessionExpiry |
Session expiry time in seconds. | 86400 |
auth.sessionMaxLifetime |
Maximum session lifetime in seconds. | 0 |
auth.loginTimeout |
Login timeout in seconds. | 300 |
auth.loginMaxRetries |
Maximum login retries. | 3 |
auth.trustedProxies |
Comma-separated list of trusted proxy addresses. | `` |
auth.acls.policy |
ACL policy for allow-by-default or deny-by-default, available options are allow and deny, default is allow. | allow |
apps
| Option | Description | Default |
|---|---|---|
apps.[name].config.domain |
The domain of the app. | `` |
apps.[name].users.allow |
Comma-separated list of allowed users. | `` |
apps.[name].users.block |
Comma-separated list of blocked users. | `` |
apps.[name].oauth.whitelist |
Comma-separated list of allowed OAuth groups. | `` |
apps.[name].oauth.groups |
Comma-separated list of required OAuth groups. | `` |
apps.[name].ip.allow |
List of allowed IPs or CIDR ranges. | `` |
apps.[name].ip.block |
List of blocked IPs or CIDR ranges. | `` |
apps.[name].ip.bypass |
List of IPs or CIDR ranges that bypass authentication. | `` |
apps.[name].response.headers |
Custom headers to add to the response. | `` |
apps.[name].response.basicauth.username |
Basic auth username. | `` |
apps.[name].response.basicauth.password |
Basic auth password. | `` |
apps.[name].response.basicauth.passwordFile |
Path to the file containing the basic auth password. | `` |
apps.[name].path.allow |
Disable authentication for only paths that match the regex string. | `` |
apps.[name].path.block |
Enable authentication for only paths that match the regex string. | `` |
apps.[name].ldap.groups |
Comma-separated list of required LDAP groups. | `` |
oauth
| Option | Description | Default |
|---|---|---|
oauth.whitelist |
Comma-separated list of allowed OAuth domains. | `` |
oauth.whitelistFile |
Path to the OAuth whitelist file. | `` |
oauth.autoRedirect |
The OAuth provider to use for automatic redirection. | `` |
oauth.providers.[name].clientId |
OAuth client ID. | `` |
oauth.providers.[name].clientSecret |
OAuth client secret. | `` |
oauth.providers.[name].clientSecretFile |
Path to the file containing the OAuth client secret. | `` |
oauth.providers.[name].whitelist |
Comma-separated list of allowed OAuth domains for this provider. | `` |
oauth.providers.[name].whitelistFile |
Path to the OAuth whitelist file for this provider. | `` |
oauth.providers.[name].scopes |
OAuth scopes. | `` |
oauth.providers.[name].redirectUrl |
OAuth redirect URL. | `` |
oauth.providers.[name].authUrl |
OAuth authorization URL. | `` |
oauth.providers.[name].tokenUrl |
OAuth token URL. | `` |
oauth.providers.[name].userinfoUrl |
OAuth userinfo URL. | `` |
oauth.providers.[name].insecure |
Allow insecure OAuth connections. | false |
oauth.providers.[name].name |
Provider name in UI. | `` |
oauth.providers.[name].claims.username |
Username claim. | `` |
oauth.providers.[name].claims.email |
Email claim. | `` |
oauth.providers.[name].claims.name |
Name claim. | `` |
oauth.providers.[name].claims.groups |
Groups claim. | `` |
oidc
| Option | Description | Default |
|---|---|---|
oidc.privateKeyPath |
Path to the private key file, including file name. | ./tinyauth_oidc_key |
oidc.publicKeyPath |
Path to the public key file, including file name. | ./tinyauth_oidc_key.pub |
oidc.clients.[name].clientId |
OIDC client ID. | `` |
oidc.clients.[name].clientSecret |
OIDC client secret. | `` |
oidc.clients.[name].clientSecretFile |
Path to the file containing the OIDC client secret. | `` |
oidc.clients.[name].trustedRedirectUris |
List of trusted redirect URIs. | `` |
oidc.clients.[name].name |
Client name in UI. | `` |
ui
| Option | Description | Default |
|---|---|---|
ui.title |
The title of the UI. | Tinyauth |
ui.forgotPasswordMessage |
Message displayed on the forgot password page. | You can change your password by changing the configuration. |
ui.backgroundImage |
Path to the background image. | /background.webp |
ui.warningsEnabled |
Enable UI warnings. | true |
ldap
| Option | Description | Default |
|---|---|---|
ldap.address |
LDAP server address. | `` |
ldap.bindDn |
Bind DN for LDAP authentication. | `` |
ldap.bindPassword |
Bind password for LDAP authentication. | `` |
ldap.bindPasswordFile |
Path to the Bind password. | `` |
ldap.baseDn |
Base DN for LDAP searches. | `` |
ldap.insecure |
Allow insecure LDAP connections. | false |
ldap.searchFilter |
LDAP search filter. | (uid=%s) |
ldap.authCert |
Certificate for mTLS authentication. | `` |
ldap.authKey |
Certificate key for mTLS authentication. | `` |
ldap.groupCacheTTL |
Cache duration for LDAP group membership in seconds. | 900 |
experimental
| Option | Description | Default |
|---|---|---|
experimental.oauthBridgeEnabled |
Enable the OAuth bridge, uses a new way to format OAuth user information. | false |
experimental.disableAuthModuleFallback |
Disable the fallback to forward_auth modules when auth_request or ext_authz fail. | false |
tailscale
| Option | Description | Default |
|---|---|---|
tailscale.enabled |
Enable Tailscale integration. | false |
tailscale.apiToken |
Tailscale API token. | `` |
tailscale.apiTokenFile |
Path to the file containing the Tailscale API token. | `` |
tailscale.tailnet |
Tailnet name. | `` |
tailscale.cacheDuration |
Cache duration for Tailscale device and user lists in seconds. | 300 |
log
| Option | Description | Default |
|---|---|---|
log.level |
Log level (trace, debug, info, warn, error). | info |
log.json |
Enable JSON formatted logs. | false |
log.streams.http.enabled |
Enable this log stream. | true |
log.streams.http.level |
Log level for this stream. Use global if empty. | `` |
log.streams.app.enabled |
Enable this log stream. | true |
log.streams.app.level |
Log level for this stream. Use global if empty. | `` |
log.streams.audit.enabled |
Enable this log stream. | false |
log.streams.audit.level |
Log level for this stream. Use global if empty. | `` |
