[GitHub] [apisix-dashboard] gxthrj commented on a change in pull request #356: Feat release 1.5

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

gxthrj commented on a change in pull request #356:
URL: https://github.com/apache/apisix-dashboard/pull/356#discussion_r464761936



##########
File path: README.md
##########
@@ -16,15 +16,73 @@
 # limitations under the License.
 #
 -->
+
 # Apache APISIX Dashboard
 
-Dashboard for [Apache APISIX](https://github.com/apache/incubator-apisix-dashboard)
+Dashboard for [Apache APISIX](https://github.com/apache/apisix-dashboard)
 
-## Deploy with Docker (currently)
+## Deploy with Docker
 
 Please refer to [Deploy with Docker README](./compose/README.md)
 
-## More
+## Deploy Manually
+
+### Build the manager-api
+
+The `manager-api` is used to provide APIs for Dashboard, just like a bridge between the Apache APISIX and the Dashboard. Here are the steps to build it manually:
+
+1. We need `MySQL/Golang` to be preinstalled.
+
+```sh
+# e.g Initialization for MySQL
+$ mysql –uroot –p123456 
+> source $PROJECT_ROOT_FOLDER/api/script/db/schema.sql
+```
+
+2. Start the Apache APISIX.
+
+[Please follow this guide](https://github.com/apache/apisix#configure-and-installation)
+
+3. Set environment variables
+
+According to your local deployment environment, modify the environment variables in `$PROJECT_ROOT_FOLDER/api/run/run.sh`

Review comment:
       the environment variables are about `mysql` and `APISIX`, which is depended by `manager-api`.
   in `run.sh` we give the default config, maybe user need to modify
   ```sh
   export MYSQL_SERVER_ADDRESS="127.0.0.1:3306"
   export MYSQL_USER=root
   export MYSQL_PASSWORD=123456
   export SYSLOG_HOST=127.0.0.1
   export APISIX_BASE_URL="http://127.0.0.1:9080/apisix/admin"
   export APISIX_API_KEY="edd1c9f034335f136f87ad84b625c8f1"
   ```




----------------------------------------------------------------
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