This is an automated email from the ASF dual-hosted git repository. majunjie pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/apisix-dashboard.git
The following commit(s) were added to refs/heads/master by this push: new d2232e1 docs: manager-api as os service (#1885) d2232e1 is described below commit d2232e1e82eabd65e37991ed36dad5f7b67cc68c Author: Bisakh Mondal <bisakhmonda...@gmail.com> AuthorDate: Mon May 24 15:06:11 2021 +0530 docs: manager-api as os service (#1885) --- docs/en/latest/deploy-with-rpm.md | 5 ++++- docs/en/latest/deploy.md | 31 +++++++++++++++++++++++++++++-- 2 files changed, 33 insertions(+), 3 deletions(-) diff --git a/docs/en/latest/deploy-with-rpm.md b/docs/en/latest/deploy-with-rpm.md index b3820be..2f5c5ec 100644 --- a/docs/en/latest/deploy-with-rpm.md +++ b/docs/en/latest/deploy-with-rpm.md @@ -26,7 +26,7 @@ title: Deploy with RPM ## Install from RPM ```sh -$ sudo yum install -y https://github.com/apache/apisix-dashboard/releases/download/v2.4/apisix-dashboard-2.4-0.x86_64.rpm +$ sudo yum install -y https://github.com/apache/apisix-dashboard/releases/download/v2.6/apisix-dashboard-2.6-0.x86_64.rpm ``` ## Run @@ -37,4 +37,7 @@ Before you start, make sure the following dependencies are installed and running ```sh $ sudo nohup manager-api -p /usr/local/apisix/dashboard/ & + +# or manager-api as a service +$ sudo manager-api start -p /usr/local/apisix/dashboard/ ``` diff --git a/docs/en/latest/deploy.md b/docs/en/latest/deploy.md index b5a2e68..e7a52ec 100644 --- a/docs/en/latest/deploy.md +++ b/docs/en/latest/deploy.md @@ -57,7 +57,7 @@ $ make build When the build is complete, the results are stored in the root `output` directory. -Note: `make build` will build `manger-api` and `web`, use the `make help` command to see more commands. +Note: `make build` will build `manager-api` and `web`, use the `make help` command to see more commands. ## Launch @@ -89,9 +89,36 @@ run: $ ./manager-api stop ``` +### Optional + +6. Running `manager-api` as an OS service. + +Without clubbing `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. + +**Note:** The `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. + +```sh +# 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 +``` + ## Working directory -the `output` directory mention above is the default working directory. +The `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.