Skip to content

Configuration

Tinyauth can be configured using environment variables or CLI flags. The table below provides a comprehensive list of configuration options.

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. ``