mirror of
https://github.com/Frooodle/Stirling-PDF.git
synced 2025-01-28 00:22:33 +01:00
125 lines
8.0 KiB
Plaintext
125 lines
8.0 KiB
Plaintext
#############################################################################################################
|
|
# Welcome to settings file from #
|
|
# ____ _____ ___ ____ _ ___ _ _ ____ ____ ____ _____ #
|
|
# / ___|_ _|_ _| _ \| | |_ _| \ | |/ ___| | _ \| _ \| ___| #
|
|
# \___ \ | | | || |_) | | | || \| | | _ _____| |_) | | | | |_ #
|
|
# ___) || | | || _ <| |___ | || |\ | |_| |_____| __/| |_| | _| #
|
|
# |____/ |_| |___|_| \_\_____|___|_| \_|\____| |_| |____/|_| #
|
|
# #
|
|
# Do not comment out any entry, it will be removed on next startup #
|
|
# If you want to override with environment parameter follow parameter naming SECURITY_INITIALLOGIN_USERNAME #
|
|
#############################################################################################################
|
|
|
|
|
|
security:
|
|
enableLogin: false # set to 'true' to enable login
|
|
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
|
|
google:
|
|
clientId: '' # client ID for Google OAuth2
|
|
clientSecret: '' # client secret for Google OAuth2
|
|
scopes: https://www.googleapis.com/auth/userinfo.email, https://www.googleapis.com/auth/userinfo.profile # scopes for Google OAuth2
|
|
useAsUsername: email # field to use as the username for Google OAuth2
|
|
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
|
|
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)
|
|
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
|
|
idpMetadataUri: https://dev-XXXXXXXX.okta.com/app/externalKey/sso/saml/metadata
|
|
idpSingleLogoutUrl: https://dev-XXXXXXXX.okta.com/app/dev-XXXXXXXX_stirlingpdf_1/externalKey/slo/saml
|
|
idpSingleLoginUrl: https://dev-XXXXXXXX.okta.com/app/dev-XXXXXXXX_stirlingpdf_1/externalKey/sso/saml
|
|
idpIssuer: http://www.okta.com/externalKey
|
|
idpCert: classpath:okta.crt
|
|
privateKey: classpath:saml-private-key.key
|
|
spCert: classpath:saml-public-cert.crt
|
|
|
|
enterpriseEdition:
|
|
enabled: false # set to 'true' to enable enterprise edition
|
|
key: 00000000-0000-0000-0000-000000000000
|
|
CustomMetadata:
|
|
autoUpdateMetadata: false # set to 'true' to automatically update metadata with below values
|
|
author: username # supports text such as 'John Doe' or types such as username to autopopulate with user's username
|
|
creator: Stirling-PDF # supports text such as 'Company-PDF'
|
|
producer: Stirling-PDF # supports text such as 'Company-PDF'
|
|
|
|
legal:
|
|
termsAndConditions: https://www.stirlingpdf.com/terms-and-conditions # 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: undefined # set to 'true' to enable analytics, set to 'false' to disable analytics; for enterprise users, this is set to true
|
|
|
|
ui:
|
|
appName: '' # application's visible name
|
|
homeDescription: '' # short description or tagline shown on the homepage
|
|
appNameNavbar: '' # name displayed on the navigation bar
|
|
|
|
endpoints:
|
|
toRemove: [] # list endpoints to disable (e.g. ['img-to-pdf', 'remove-pages'])
|
|
groupsToRemove: [] # list groups to disable (e.g. ['LibreOffice'])
|
|
|
|
metrics:
|
|
enabled: true # 'true' to enable Info APIs (`/api/*`) endpoints, 'false' to disable
|
|
|
|
# Automatically Generated Settings (Do Not Edit Directly)
|
|
AutomaticallyGenerated:
|
|
key: example
|
|
UUID: example
|
|
appVersion: 0.35.0
|
|
|
|
processExecutor:
|
|
sessionLimit: # Process executor instances limits
|
|
libreOfficeSessionLimit: 1
|
|
pdfToHtmlSessionLimit: 1
|
|
qpdfSessionLimit: 4
|
|
tesseractSessionLimit: 1
|
|
pythonOpenCvSessionLimit: 8
|
|
weasyPrintSessionLimit: 16
|
|
installAppSessionLimit: 1
|
|
calibreSessionLimit: 1
|
|
timeoutMinutes: # Process executor timeout in minutes
|
|
libreOfficetimeoutMinutes: 30
|
|
pdfToHtmltimeoutMinutes: 20
|
|
pythonOpenCvtimeoutMinutes: 30
|
|
weasyPrinttimeoutMinutes: 30
|
|
installApptimeoutMinutes: 60
|
|
calibretimeoutMinutes: 30
|
|
tesseractTimeoutMinutes: 30
|