add cors doc

Author: timzaak

config.release.toml

@@ -1,17 +1,18 @@
 ## directory to store static web files. if you use docker, please mount a persistence volume for it.
 file_dir = "/data"
 
-## enable cors, default is false, its implementation is simple now.
+## enable cors, default is none, when set '*', then all cors is ok.
 ## Access-Control-Allow-Origin: $ORIGIN
 ## Access-Control-Allow-Methods: OPTION,GET,HEAD
 ## Access-Control-Max-Age: 3600
-## If you put the server behind HTTPS proxy, please enable it
-cors = false
+## If you put the server behind HTTPS proxy, please enable it, or domains.cors = ['?']
+## Attension: domains.cors would overwrite the cors config, rather than merge this.
+cors = ['*']
 ## http bind, if set port <= 0 or remove http, will disable http server(need set https config)
 [http]
 port = 80
 addr = "0.0.0.0"
-## port when serving public PI,default is http port. external_port should not be 0.
+## port when serving public network,default is http port. external_port should not be 0.
 # external_port = 80
 
 ## optional, when https enabled, redirect_https default value true
@@ -21,7 +22,7 @@ addr = "0.0.0.0"
 # [https]
 # port = 443 # https bind address
 # addr = "0.0.0.0"
-## port when serving public PI,default is https port. external_port should not be 0.
+## port when serving public network,default is https port. external_port should not be 0.
 # external_port = 443
 
 ## if set true, http server(80) will send client
@@ -89,7 +90,7 @@ addr = "0.0.0.0"
 # domain = "www.example.com"
 ## optional, `example.com` would redirect to `www.example.com`
 # alias = ["example.com"]
-# cors = false
+# cors = ['https://www.example.com', 'http://www.baidu.com']
 # [domains.https]
 ## optional, when https enabled, redirect_https default value true
 ## it would the port would be https.external_port(https.external_port should be defined), otherwise is false
@@ -106,7 +107,6 @@ addr = "0.0.0.0"
 # expire = '30d' # 30day
 # extension_names = ['icon', 'gif', 'jpg', 'jpeg', 'png', 'js']
 
-[openTelemetry]
-endpoint = "http://localhost:4317"
-
 
+# [openTelemetry]
+# endpoint = "http://localhost:4317"

docs/develop/change-log.md

@@ -1,5 +1,8 @@
 # Change Log
 
+### Version 2.4.1
+- spa-server: `cors` value bool to array string.
+
 ### Version 2.4.0
 
 - improve: extract client and server common entity

docs/guide/break-changes.md

@@ -1,5 +1,7 @@
 # Break Changes
-## V2.4.0
+## V2.4.1
+* spa-server: `cors` value bool to array string.
+## V2.4.0(2024-08-04)
 * remove hocon config format, change to toml.
 ## V2.3.0(2024-07-01)
 * spa-server: `https.http_redirect_to_https` move to `http.redirect_https`, and value is bool.

docs/guide/spa-server-configuration.md

@@ -14,17 +14,18 @@ The config default path is `./config.toml`, you can change it by environment `SP
 ## directory to store static web files. if you use docker, please mount a persistence volume for it.
 file_dir = "/data"
 
-## enable cors, default is false, its implementation is simple now.
+## enable cors, default is none, when set '*', then all cors is ok.
 ## Access-Control-Allow-Origin: $ORIGIN
 ## Access-Control-Allow-Methods: OPTION,GET,HEAD
 ## Access-Control-Max-Age: 3600
-## If you put the server behind HTTPS proxy, please enable it
-cors = false
+## If you put the server behind HTTPS proxy, please enable it, or domains.cors = ['?']
+## Attension: domains.cors would overwrite the cors config, rather than merge this.
+cors = ['*']
 ## http bind, if set port <= 0 or remove http, will disable http server(need set https config)
 [http]
 port = 80
 addr = "0.0.0.0"
-## port when serving public PI,default is http port. external_port should not be 0.
+## port when serving public network,default is http port. external_port should not be 0.
 # external_port = 80
 
 ## optional, when https enabled, redirect_https default value true
@@ -34,7 +35,7 @@ addr = "0.0.0.0"
 # [https]
 # port = 443 # https bind address
 # addr = "0.0.0.0"
-## port when serving public PI,default is https port. external_port should not be 0.
+## port when serving public network,default is https port. external_port should not be 0.
 # external_port = 443
 
 ## if set true, http server(80) will send client
@@ -102,7 +103,7 @@ addr = "0.0.0.0"
 # domain = "www.example.com"
 ## optional, `example.com` would redirect to `www.example.com`
 # alias = ["example.com"]
-# cors = false
+# cors = ['https://www.example.com', 'http://www.baidu.com']
 # [domains.https]
 ## optional, when https enabled, redirect_https default value true
 ## it would the port would be https.external_port(https.external_port should be defined), otherwise is false