Stirling-PDF/src/main/resources/settings.yml.template

# Welcome to settings file
# Remove comment marker # if on start of line to enable the configuration
# If you want to override with environment parameter follow parameter naming SECURITY_INITIALLOGIN_USERNAME

security:
  enableLogin: false # set to 'true' to enable login
  csrfDisabled: true
  loginAttemptCount: 5 # lock user account after 5 tries
  loginResetTimeMinutes : 120 # lock account for 2 hours after x attempts
  #oauth2:
  #  enabled: false # set to 'true' to enable login (Note: enableLogin must also be 'true' for this to work)
  #  issuer: "" # set to any provider that supports OpenID Connect Discovery (/.well-known/openid-configuration) end-point
  #  clientId: "" # Client ID from your provider
  #  clientSecret: "" # Client Secret from your provider
  #  autoCreateUser: false # set to 'true' to allow auto-creation of non-existing users

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: true # 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
  
#ui:
#  appName: exampleAppName # Application's visible name
#  homeDescription: I am a description # Short description or tagline shown on homepage.
#  appNameNavbar: navbarName # 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
name changes 2023-08-27 01:38:17 +02:00			`# Welcome to settings file`
			`# Remove comment marker # if on start of line to enable the configuration`
			`# If you want to override with environment parameter follow parameter naming SECURITY_INITIALLOGIN_USERNAME`

config template 2023-08-26 13:27:52 +02:00			`security:`
			`enableLogin: false # set to 'true' to enable login`
			`csrfDisabled: true`
reviews 2023-12-29 21:48:21 +01:00			`loginAttemptCount: 5 # lock user account after 5 tries`
			`loginResetTimeMinutes : 120 # lock account for 2 hours after x attempts`
Add OAUTH2 OIDC login support (#1140) * Somewhat working * Change Autocreate logic * Add OAuth Error Message if Auto create Disabled * Display OAUTH2 username(email) in Account Settings * Disable Change user/pass for Oauth2 user * Hide SSO Button if SSO login Disabled * Remove some spaces and comments * Add OAUTH2 Login example docker-compose file * Add Some Comments * Hide Printing of Client secret * Remove OAUTH2 Beans and replace with applicationProperties * Add conditional annotation to Bean Creation * Update settings.yml.template Add OAUTH2 enabling template. * Update messages_en_GB.properties 2024-04-29 23:01:22 +02:00			`#oauth2:`
			`# enabled: false # set to 'true' to enable login (Note: enableLogin must also be 'true' for this to work)`
			`# issuer: "" # set to any provider that supports OpenID Connect Discovery (/.well-known/openid-configuration) end-point`
			`# clientId: "" # Client ID from your provider`
			`# clientSecret: "" # Client Secret from your provider`
			`# autoCreateUser: false # set to 'true' to allow auto-creation of non-existing users`
refactor: normalize files 2024-02-11 17:47:00 +01:00
config template 2023-08-26 13:27:52 +02:00			`system:`
			`defaultLocale: 'en-US' # Set the default language (e.g. 'de-DE', 'fr-FR', etc)`
Update settings docs 2023-09-02 12:30:27 +02:00			`googlevisibility: false # 'true' to allow Google visibility (via robots.txt), 'false' to disallow`
enableAlphaFunctionality 2023-12-26 21:10:37 +01:00			`enableAlphaFunctionality: false # Set to enable functionality which might need more testing before it fully goes live (This feature might make no changes)`
UI: settings show/hide update display (#1072) * UI: settings show/hide update display This PR replaces the PR #1003 In this PR, the visual for available update is added to the foreground. There are new settings to generally show/hide the update display, and only administrators receive the update display. * change to `Bean` * Update AppUpdateShowService.java * add update message * revision service * change shouldShow * Update githubVersion.js * rm folder * Update AppUpdateService.java 2024-04-21 13:15:18 +02:00			`showUpdate: true # 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'`
Custom HTML support #355 (#1129) * test * settings * version 2024-04-27 12:03:57 +02:00			`customHTMLFiles: false # Enable to have files placed in /customFiles/templates override the existing template html files`

name changes 2023-08-27 01:38:17 +02:00			`#ui:`
			`# appName: exampleAppName # Application's visible name`
			`# homeDescription: I am a description # Short description or tagline shown on homepage.`
			`# appNameNavbar: navbarName # Name displayed on the navigation bar`
config template 2023-08-26 13:27:52 +02:00
			`endpoints:`
			`toRemove: [] # List endpoints to disable (e.g. ['img-to-pdf', 'remove-pages'])`
			`groupsToRemove: [] # List groups to disable (e.g. ['LibreOffice'])`

			`metrics:`
Update settings docs 2023-09-02 12:30:27 +02:00			enabled: true # 'true' to enable Info APIs (`/api/*`) endpoints, 'false' to disable