diff --git a/README.md b/README.md index 50928630..9895e206 100644 --- a/README.md +++ b/README.md @@ -222,28 +222,25 @@ The Current list of settings is ```yaml security: enableLogin: false # set to 'true' to enable login - csrfDisabled: true # Set to 'true' to disable CSRF protection (not recommended for production) + 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' +# initialLogin: +# username: "admin" # Initial username for the first login (these are defaulted) +# 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 - 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' @@ -260,9 +257,6 @@ endpoints: metrics: enabled: true # 'true' to enable Info APIs (`/api/*`) endpoints, 'false' to disable - -autoPipeline: - outputFolder: /output # Directory for auto-pipeline outputs. ``` 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/java/stirling/software/SPDF/model/ApplicationProperties.java b/src/main/java/stirling/software/SPDF/model/ApplicationProperties.java index 2623d8f8..ae96d07b 100644 --- a/src/main/java/stirling/software/SPDF/model/ApplicationProperties.java +++ b/src/main/java/stirling/software/SPDF/model/ApplicationProperties.java @@ -327,9 +327,6 @@ public class ApplicationProperties { public static class System { private String defaultLocale; private Boolean googlevisibility; - private String rootURIPath; - private String customStaticFilePath; - private Integer maxFileSize; private boolean showUpdate; private Boolean showUpdateOnlyAdmin; private boolean customHTMLFiles; @@ -384,29 +381,8 @@ public class ApplicationProperties { this.googlevisibility = googlevisibility; } - public String getRootURIPath() { - return rootURIPath; - } + - public void setRootURIPath(String rootURIPath) { - this.rootURIPath = rootURIPath; - } - - public String getCustomStaticFilePath() { - return customStaticFilePath; - } - - public void setCustomStaticFilePath(String customStaticFilePath) { - this.customStaticFilePath = customStaticFilePath; - } - - public Integer getMaxFileSize() { - return maxFileSize; - } - - public void setMaxFileSize(Integer maxFileSize) { - this.maxFileSize = maxFileSize; - } @Override public String toString() { @@ -414,12 +390,6 @@ public class ApplicationProperties { + defaultLocale + ", googlevisibility=" + googlevisibility - + ", rootURIPath=" - + rootURIPath - + ", customStaticFilePath=" - + customStaticFilePath - + ", maxFileSize=" - + maxFileSize + ", enableAlphaFunctionality=" + enableAlphaFunctionality + ", showUpdate=" diff --git a/src/main/resources/settings.yml.template b/src/main/resources/settings.yml.template index d504e82e..d771f9c9 100644 --- a/src/main/resources/settings.yml.template +++ b/src/main/resources/settings.yml.template @@ -7,25 +7,22 @@ security: 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' +# 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 - 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'