csrfDisabled:false# set to 'true' to disable CSRF protection (not recommended for production)
loginAttemptCount:5# lock user account after 5 tries; when using e.g. Fail2Ban you can deactivate the function with -1
loginResetTimeMinutes:120# lock account for 2 hours after x attempts
loginMethod:all# Accepts values like 'all' and 'normal'(only Login with Username/Password), 'oauth2'(only Login with OAuth2) or 'saml2'(only Login with SAML2)
initialLogin:
username:''# initial username for the first login
password:''# initial password for the first login
oauth2:
enabled: false # set to 'true' to enable login (Note:enableLogin must also be 'true' for this to work)
client:
keycloak:
issuer:''# URL of the Keycloak realm's OpenID Connect Discovery endpoint
clientId:''# client ID for Keycloak OAuth2
clientSecret:''# client secret for Keycloak OAuth2
scopes:openid, profile, email# scopes for Keycloak OAuth2
useAsUsername: preferred_username # field to use as the username for Keycloak OAuth2. Available options are:[email | name | given_name | family_name | preferred_name]
google:
clientId:''# client ID for Google OAuth2
clientSecret:''# client secret for Google OAuth2
scopes:email, profile# scopes for Google OAuth2
useAsUsername: email # field to use as the username for Google OAuth2. Available options are:[email | name | given_name | family_name]
github:
clientId:''# client ID for GitHub OAuth2
clientSecret:''# client secret for GitHub OAuth2
scopes:read:user# scope for GitHub OAuth2
useAsUsername: login # field to use as the username for GitHub OAuth2. Available options are:[email | login | name]
issuer:''# set to any Provider that supports OpenID Connect Discovery (/.well-known/openid-configuration) endpoint
clientId:''# client ID from your Provider
clientSecret:''# client secret from your Provider
autoCreateUser:true# set to 'true' to allow auto-creation of non-existing users
blockRegistration:false# set to 'true' to deny login with SSO without prior registration by an admin
useAsUsername:email# default is 'email'; custom fields can be used as the username
scopes:openid, profile, email# specify the scopes for which the application will request permissions
provider:google# set this to your OAuth Provider's name, e.g., 'google' or 'keycloak'
saml2:
enabled:false# Only enabled for paid enterprise clients (enterpriseEdition.enabled must be true)
provider:''# The name of your Provider
autoCreateUser:true# set to 'true' to allow auto-creation of non-existing users
blockRegistration:false# set to 'true' to deny login with SSO without prior registration by an admin
registrationId:stirling# The name of your Service Provider (SP) app name. Should match the name in the path for your SSO & SLO URLs
idpMetadataUri:https://dev-XXXXXXXX.okta.com/app/externalKey/sso/saml/metadata# The uri for your Provider's metadata
idpSingleLoginUrl:https://dev-XXXXXXXX.okta.com/app/dev-XXXXXXXX_stirlingpdf_1/externalKey/sso/saml# The URL for initiating SSO. Provided by your Provider
idpSingleLogoutUrl:https://dev-XXXXXXXX.okta.com/app/dev-XXXXXXXX_stirlingpdf_1/externalKey/slo/saml# The URL for initiating SLO. Provided by your Provider
idpIssuer:''# The ID of your Provider
idpCert:classpath:okta.cert# The certificate your Provider will use to authenticate your app's SAML authentication requests. Provided by your Provider
privateKey:classpath:saml-private-key.key# Your private key. Generated from your keypair
spCert:classpath:saml-public-cert.crt# Your signing certificate. Generated from your keypair
termsAndConditions:https://www.stirlingpdf.com/terms# URL to the terms and conditions of your application (e.g. https://example.com/terms). Empty string to disable or filename to load from local file in static folder
privacyPolicy:https://www.stirlingpdf.com/privacy-policy# URL to the privacy policy of your application (e.g. https://example.com/privacy). Empty string to disable or filename to load from local file in static folder
accessibilityStatement:''# URL to the accessibility statement of your application (e.g. https://example.com/accessibility). Empty string to disable or filename to load from local file in static folder
cookiePolicy:''# URL to the cookie policy of your application (e.g. https://example.com/cookie). Empty string to disable or filename to load from local file in static folder
impressum:''# URL to the impressum of your application (e.g. https://example.com/impressum). Empty string to disable or filename to load from local file in static folder
system:
defaultLocale:en-US# set the default language (e.g. 'de-DE', 'fr-FR', etc)
googlevisibility:false# 'true' to allow Google visibility (via robots.txt), 'false' to disallow
enableAlphaFunctionality:false# set to enable functionality which might need more testing before it fully goes live (this feature might make no changes)
showUpdate:false# see when a new update is available
showUpdateOnlyAdmin:false# only admins can see when a new update is available, depending on showUpdate it must be set to 'true'
customHTMLFiles:false# enable to have files placed in /customFiles/templates override the existing template HTML files
tessdataDir:/usr/share/tessdata# path to the directory containing the Tessdata files. This setting is relevant for Windows systems. For Windows users, this path should be adjusted to point to the appropriate directory where the Tessdata files are stored.
enableAnalytics:true# set to 'true' to enable analytics, set to 'false' to disable analytics; for enterprise users, this is set to true
disableSanitize:false# set to true to disable Sanitize HTML; (can lead to injections in HTML)
datasource:
enableCustomDatabase:false# Enterprise users ONLY, set this property to 'true' if you would like to use your own custom database configuration
customDatabaseUrl:''# eg jdbc:postgresql://localhost:5432/postgres, set the url for your own custom database connection. If provided, the type, hostName, port and name are not necessary and will not be used
username:postgres# set the database username
password:postgres# set the database password
type:postgresql# the type of the database to set (e.g. 'h2', 'postgresql')
hostName:localhost# the host name to use for the database url. Set to 'localhost' when running the app locally. Set to match the name of the container name of your database container when running the app on a server (Docker configuration)
port:5432# set the port number of the database. Ensure this matches the port the database is listening to
name:postgres# set the name of your database. Should match the name of the database you create
weasyprint:''# Defaults to /opt/venv/bin/weasyprint
unoconvert:''# Defaults to /opt/venv/bin/unoconvert
fileUploadLimit:''# Defaults to "". No limit when string is empty. Set a number, between 0 and 999, followed by one of the following strings to set a limit. "KB", "MB", "GB".
