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



##########
File path: api/conf/conf.yaml
##########
@@ -17,16 +17,18 @@
 
 conf:
   listen:
-    host: 127.0.0.1
-    port: 8080
+    host: 127.0.0.1          # `manager api` listening ip or host name
+    port: 8080               # `manager api` listening port
   etcd:
-    endpoints:
+    endpoints:               # it's possible to define multiple etcd hosts 
addresses of the same etcd cluster.
       - 127.0.0.1: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:
       need a space, `# username ...`

##########
File path: api/conf/conf.yaml
##########
@@ -17,16 +17,18 @@
 
 conf:
   listen:
-    host: 127.0.0.1
-    port: 8080
+    host: 127.0.0.1          # `manager api` listening ip or host name
+    port: 8080               # `manager api` listening port
   etcd:
-    endpoints:
+    endpoints:               # it's possible to define multiple etcd hosts 
addresses of the same etcd cluster.

Review comment:
       please use better comments, it is not easy to understand

##########
File path: api/test/docker/manager-api-conf.yaml
##########
@@ -15,20 +15,24 @@
 # limitations under the License.
 #
 
+

Review comment:
       I do not think that is a good way to copy the `api/conf/conf.yaml` again 
only for testing.
   
   we should use `cp` + `sed` to generate `manager-api-conf.yaml`




----------------------------------------------------------------
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:
[email protected]


Reply via email to