The Dashboard contains both
web is optional.
web will be included in this build guide product.
Before using source codes to build, make sure that the following dependencies are installed in your environment.
- Golang 1.13+: For users in mainland China, you can use the following command to speed up the module downloads.
$ go env -w GOPROXY=https://goproxy.cn,direct
$ git clone -b release/2.9.0 https://github.com/apache/apisix-dashboard.git
$ cd apisix-dashboard
$ make build
When the build is complete, the results are stored in the root
make build will build
web, use the
make help command to see more commands.
- After the build is complete and before you start, make sure the following dependencies are installed and running in your environment.
- etcd 3.4.0+
Check and modify the configuration information in
output/conf/conf.yamlaccording to your deployment environment.
Launch the Dashboard
$ cd ./output
# or running in background
$ nohup ./manager-api &
Without changing the configuration, visit
http://127.0.0.1:9000to use the dashboard with GUI, where the default username and password are
Stop the Dashboard
manager-api provides a sub command
stop to quit the program gracefully, just
$ ./manager-api stop
manager-apias an OS service.
manager-api with external command such as
nohup (in Unix systems), we also provide a long term solution for running the program as an operating system managed background service. The feature is cross-platform, os agnostic and works on well known Linux, Windows and Mac OS distributions.
manager-api as a service is listed by the name
apisix-dashboard under the OS's service manager.
manager-api provides a list of sub commands to start and manage the lifecycle of the background service.
# start Apache APISIX Dashboard service
$ ./manager-api start
# re-install Apache APISIX Dashboard service
$ ./manager-api install
# inspect the status of Apache APISIX Dashboard service
$ ./manager-api status
# stop Apache APISIX Dashboard service. stop can be used with or without service
$ ./manager-api stop
# remove Apache APISIX Dashboard service
$ ./manager-api remove
output directory mention above is the default working directory.
You can move the entire directory to any path you want, and use the
-p to specify it as the working directory.
For example, you can move it to
$ mv ./output/manager-api /usr/local/bin/
$ mv ./output/ /usr/local/apisix-dashboard/
$ manager-api -p /usr/local/apisix-dashboard/