Installing Apache APISIX Dashboard on Linux is easy. Now, we provide Docker image and RPM installation package.
We recommend using Docker to run Dashboard:
docker pull apache/apisix-dashboard docker run -d --name dashboard \ -p 9000:9000 \ -v <CONFIG_FILE>:/usr/local/apisix-dashboard/conf/conf.yaml \ apache/apisix-dashboard
:::note Please replace <CONFIG_FILE>
to your configure file path. :::
NOTE: Only CentOS 7 is supported currently.
# 1. install RPM package sudo yum install -y https://github.com/apache/apisix-dashboard/releases/download/v2.13/apisix-dashboard-2.13-0.el7.x86_64.rpm
# run dashboard in the shell sudo manager-api -p /usr/local/apisix/dashboard/ # or run dashboard as a service systemctl start apisix-dashboard
Without changing the configuration, visit http://127.0.0.1:9000
to use the dashboard with GUI, where the default username and password are admin
.
The Dashboard project contains both manager-api
and web
, but web
is optional.
The manager-api
and 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.
For manager-api
:
Tip: 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
For web
:
git clone -b release/2.13 https://github.com/apache/apisix-dashboard.git && cd apisix-dashboard
cd apisix-dashboard make build
When the build is complete, the results are stored in the root output
directory.
Note: make build
will build manager-api
and web
, use the make help
command to see more commands.
Check and modify the configuration information in output/conf/conf.yaml
according to your deployment environment.
Launch the Dashboard
cd ./output ./manager-api
http://127.0.0.1:9000
to use the dashboard with GUI, where the default username and password are admin
.You will need to handle your own service management when deploying using the source code compilation method. We provide a service file template for operating systems that use the Systemd service manager.
mkdir -p /usr/local/apisix-dashboard cp -rf ./output/* /usr/local/apisix-dashboard
Copy the following or use this file directly, you need to copy it to the /usr/lib/systemd/system
directory and execute the systemctl daemon-reload
command.
# copy service unit cp ./api/service/apisix-dashboard.service /usr/lib/systemd/system/apisix-dashboard.service systemctl daemon-reload # or: If you need to modify the service unit, you can use the following command echo "[Unit] Description=apisix-dashboard Conflicts=apisix-dashboard.service After=network-online.target [Service] WorkingDirectory=/usr/local/apisix-dashboard ExecStart=/usr/local/apisix-dashboard/manager-api -c /usr/local/apisix-dashboard/conf/conf.yaml" > /usr/lib/systemd/system/apisix-dashboard.service
You can use the following command to manage the service.
# start apisix-dashboard systemctl start apisix-dashboard # stop apisix-dashboard systemctl stop apisix-dashboard # check apisix-dashboard status systemctl status apisix-dashboard