Skip to content

Commit 796bf91

Browse files
authored
Normalize settings.yml.template formatting to YAML 1.2 spec (#3294)
# Description of Changes Please provide a summary of the changes, including: This PR improves the formatting of `settings.yml.template` to better align with [YAML 1.2 specification](https://yaml.org/spec/1.2/spec.html): - Removed unnecessary blank lines for cleaner structure. - Replaced double quotes `""` with single quotes `''` for empty string values, as per YAML 1.2 best practices. - Cleaned up indentation and spacing for better consistency. - Preserved all default values and comments without functional changes. This helps prevent YAML parsing inconsistencies and improves readability for users customizing their `settings.yml`. Closes # (no related issue) --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [x] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
1 parent 40211e8 commit 796bf91

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

src/main/resources/settings.yml.template

+6-10
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
# If you want to override with environment parameter follow parameter naming SECURITY_INITIALLOGIN_USERNAME #
1111
#############################################################################################################
1212

13-
1413
security:
1514
enableLogin: false # set to 'true' to enable login
1615
csrfDisabled: false # set to 'true' to disable CSRF protection (not recommended for production)
@@ -61,7 +60,6 @@ security:
6160
privateKey: classpath:saml-private-key.key # Your private key. Generated from your keypair
6261
spCert: classpath:saml-public-cert.crt # Your signing certificate. Generated from your keypair
6362

64-
6563
premium:
6664
key: 00000000-0000-0000-0000-000000000000
6765
enabled: false # Enable license key checks for pro/enterprise features
@@ -107,13 +105,11 @@ system:
107105
name: postgres # set the name of your database. Should match the name of the database you create
108106
customPaths:
109107
pipeline:
110-
watchedFoldersDir: "" #Defaults to /pipeline/watchedFolders
111-
finishedFoldersDir: "" #Defaults to /pipeline/finishedFolders
108+
watchedFoldersDir: '' #Defaults to /pipeline/watchedFolders
109+
finishedFoldersDir: '' #Defaults to /pipeline/finishedFolders
112110
operations:
113-
weasyprint: "" #Defaults to /opt/venv/bin/weasyprint
114-
unoconvert: "" #Defaults to /opt/venv/bin/unoconvert
115-
116-
111+
weasyprint: '' #Defaults to /opt/venv/bin/weasyprint
112+
unoconvert: '' #Defaults to /opt/venv/bin/unoconvert
117113

118114
ui:
119115
appName: '' # application's visible name
@@ -135,7 +131,7 @@ AutomaticallyGenerated:
135131
appVersion: 0.35.0
136132

137133
processExecutor:
138-
sessionLimit: # Process executor instances limits
134+
sessionLimit: # Process executor instances limits
139135
libreOfficeSessionLimit: 1
140136
pdfToHtmlSessionLimit: 1
141137
qpdfSessionLimit: 4
@@ -144,7 +140,7 @@ processExecutor:
144140
weasyPrintSessionLimit: 16
145141
installAppSessionLimit: 1
146142
calibreSessionLimit: 1
147-
timeoutMinutes: # Process executor timeout in minutes
143+
timeoutMinutes: # Process executor timeout in minutes
148144
libreOfficetimeoutMinutes: 30
149145
pdfToHtmltimeoutMinutes: 20
150146
pythonOpenCvtimeoutMinutes: 30

0 commit comments

Comments
 (0)