From 3f252e29a1b11c2260c8429f90330a80b74ffa83 Mon Sep 17 00:00:00 2001 From: Ludy87 Date: Sun, 19 May 2024 11:35:46 +0200 Subject: [PATCH 1/2] adds all available settings to settings.yml --- README.md | 38 +++++++++++++++++++----- src/main/resources/settings.yml.template | 9 +++++- 2 files changed, 39 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7fba0db5..71ff91b6 100644 --- a/README.md +++ b/README.md @@ -222,27 +222,51 @@ The Current list of settings is ```yaml security: enableLogin: false # set to 'true' to enable login - csrfDisabled: true + csrfDisabled: true # Set to 'true' to disable CSRF protection (not recommended for production) + loginAttemptCount: 5 # lock user account after 5 tries + loginResetTimeMinutes : 120 # lock account for 2 hours after x attempts + # initialLogin: + # username: "admin" # Initial username for the first login + # password: "stirling" # 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) + # 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 + # 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' 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 - customStaticFilePath: '/customFiles/static/' # Directory path for custom static files + rootURIPath: '/pdf-app' # ie set to /pdf-app to Set the application's root URI to localhost:8080/pdf-app + customStaticFilePath: '/customFiles/static/' # Customise static files (e.g., logo, images, CSS) by placing them in this directory. + maxFileSize: 10485760 # Maximum file size for uploads in bytes. + 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 +ui: + appName: null # Application's visible name + homeDescription: null # Short description or tagline shown on homepage. + appNameNavbar: null # 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 endpoints (view http://localhost:8080/swagger-ui/index.html#/API to learn more), 'false' to disable + enabled: true # 'true' to enable Info APIs (`/api/*`) endpoints, 'false' to disable + +autoPipeline: + outputFolder: /output # Directory for auto-pipeline outputs. + +# Automatically Generated Settings (Do Not Edit Directly) +AutomaticallyGenerated: + key: example ``` There is an additional config file ``/configs/custom_settings.yml`` were users familiar with java and spring application.properties can input their own settings on-top of Stirling-PDFs existing ones diff --git a/src/main/resources/settings.yml.template b/src/main/resources/settings.yml.template index d7d1fcfa..d504e82e 100644 --- a/src/main/resources/settings.yml.template +++ b/src/main/resources/settings.yml.template @@ -4,9 +4,12 @@ security: enableLogin: false # set to 'true' to enable login - csrfDisabled: true + csrfDisabled: true # Set to 'true' to disable CSRF protection (not recommended for production) loginAttemptCount: 5 # lock user account after 5 tries loginResetTimeMinutes : 120 # lock account for 2 hours after x attempts + # initialLogin: + # username: "admin" # Initial username for the first login + # password: "stirling" # 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) # issuer: "" # set to any provider that supports OpenID Connect Discovery (/.well-known/openid-configuration) end-point @@ -20,9 +23,13 @@ security: 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 + rootURIPath: '/pdf-app' # ie set to /pdf-app to Set the application's root URI to localhost:8080/pdf-app + customStaticFilePath: '/customFiles/static/' # Customise static files (e.g., logo, images, CSS) by placing them in this directory. + maxFileSize: 10485760 # Maximum file size for uploads in bytes. 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: null # Application's visible name From ffe221b93c08ce3d4a8466ecde968f0d8342e866 Mon Sep 17 00:00:00 2001 From: Ludy87 Date: Sun, 19 May 2024 11:36:50 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 71ff91b6..50928630 100644 --- a/README.md +++ b/README.md @@ -263,10 +263,6 @@ metrics: autoPipeline: outputFolder: /output # Directory for auto-pipeline outputs. - -# Automatically Generated Settings (Do Not Edit Directly) -AutomaticallyGenerated: - key: example ``` There is an additional config file ``/configs/custom_settings.yml`` were users familiar with java and spring application.properties can input their own settings on-top of Stirling-PDFs existing ones