[GitHub] [apisix-dashboard] juzhiyuan commented on a change in pull request #693: chore: refactor `conf` of `manager api`

[GitBox <gi...@apache.org>]

juzhiyuan commented on a change in pull request #693:
URL: https://github.com/apache/apisix-dashboard/pull/693#discussion_r517929699



##########
File path: api/test/docker/manager-api-conf.yaml
##########
@@ -15,20 +15,24 @@
 # limitations under the License.
 #
 
+
 conf:
   listen:
-    host: 0.0.0.0
-    port: 8080
+    host: 0.0.0.0            # `manager api` listening ip or host name. It's for e2e test, so it is set to 0.0.0.0
+    port: 8080               # `manager api` listening port
   etcd:
-    endpoints:
-      - 172.16.238.10:2379
+    endpoints:               # it's possible to define multiple etcd hosts addresses of the same etcd cluster.
+      - 172.16.238.10:2379   # ips here are defined in docker compose.
       - 172.16.238.11:2379
       - 172.16.238.12:2379
 authentication:
-  secret: secret
-  expireTime: 3600
+  secret: secret             # secret for jwt token generation.
+                             # *NOTE*: Highly recommended to modify this value to protect `manager api`.
+                             # if it's default value, when `manager api` start , it will generate a random string to replace it.
+  expireTime: 3600           # jwt token expire time, in second
   users:
-    - username: admin
+    - username: admin        #username and password for login `manager api`

Review comment:
       space after #




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org