Improve application.yml documentation.

README.md

@@ -1,4 +1,4 @@
-# Overview
+# WiseMapping Open Source
 
 WiseMapping is an open-source web-based mind mapping tool that harnesses the potential of Mind Maps by blending together open standards technologies like SVG and React. It is built upon the foundation of the code supporting http://www.wisemapping.com, ensuring reliability and continuity in its development.
 

wise-api/src/main/resources/application.yml

@@ -1,10 +1,13 @@
-# SpringBoot Configuration ...
+#
-server:
+#  This file contains all the defaults that it will be used when the application is started.
-  tomcat:
+#  There are two main sections: SpringBoot Config and  Application Config
-    remote-ip-header: x-forwarded-for
+#
-    protocol-header: x-forwarded-proto
 
+#
+# SpringBoot Config: WiseMapping Backend is based on SpringBoot. Additional configurations documentation could be found https://docs.spring.io/spring-boot/3.3/reference/features/external-config.html.
+#
 spring:
+  # SMTP server configuration used for password recovery and notifications.
   mail:
     host: smtp.example.com
     port: 25
@@ -16,12 +19,7 @@ spring:
           connectiontimeout: 5000
           timeout: 3000
           writetimeout: 5000
-  output:
+  # Database configuration options. Examples can be found: https://github.com/wisemapping/wisemapping-open-source/tree/develop/config/database
-    ansi:
-      enabled: always
-  application:
-    name: wisemapping-api
-    title: wisemapping-api
   datasource:
     url: jdbc:hsqldb:mem:wisemapping
     driver-class-name: org.hsqldb.jdbc.JDBCDriver
@@ -37,14 +35,24 @@ spring:
         default_batch_fetch_size: 200
         dialect: org.hibernate.dialect.HSQLDialect
         format_sql: true
-  main:
-    allow-circular-references: true
   sql:
     init:
       mode: always
       platform: hsqldb
+  # General Config: Do no touch.
+  main:
+    allow-circular-references: true
+  output:
+    ansi:
+      enabled: always
+  application:
+    name: wisemapping-api
+    title: wisemapping-api
 
-# Login ...
+
+#
+# Log Level
+#
 logging:
   level:
     org:
@@ -52,35 +60,32 @@ logging:
         tomcat: INFO
     root: INFO
 
-# Application Configuration.
+#
+# Application Config related options:
+#
 app:
+  # This information is mainly used by the frontend to connect to the backend. It must match the deployment topology used.
   site:
     ui-base-url: http://localhost
     api-base-url: http://localhost
+  # Enable API basic authentication.
   api:
     http-basic-enabled: false
-#  analytics:
+  # JSON Web Token configuration options. Secret must be configured.
-#    account:
   jwt:
     secret: dlqxKAg685SaKhsQXIMeM=JWCw3bkl3Ei3Tb7LMlnd19oMd66burPNlJ0Po1qguyjgpakQTk2CN3
     expirationMin: 10080 # One week
+  # Admin account with super admin permissions on the API.
   admin:
     user: admin@wisemapping.org
+  # STMP email configurations
   mail:
     sender-email: root@localhost
     support-email: root@localhost
     enabled: false
   accounts:
     max-inactive: 20
-  #######################################################################################
   # Google OAuth Authentication
-  #######################################################################################
-  # OAuth Client id
-  #security.oauth2.google.clientId=<config settings>
-  # OAuth Client secret
-  #security.oauth2.google.clientSecret=<oauth client>
-  # Redirect to this url, this url must be configured in the google app {ui-base-url}/c/registration-google
-  #security.oauth2.google.callbackUrl=<oauth callback url>
   security:
     #    corsAllowedOrigins: https://dev.wisemapping.com
     oauth2:
@@ -94,6 +99,7 @@ app:
   #  accounts:
   #    exclusion:
   #      domain:
+  # Account registration options dialog
   registration:
     enabled: true
     captcha:
@@ -102,3 +108,9 @@ app:
       secretKey: some-secret
 
 
+# Behind reverse proxy configuration
+server:
+  tomcat:
+    remote-ip-header: x-forwarded-for
+    protocol-header: x-forwarded-proto
+