Skip to content

docs: manager-api as os service #1885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 24, 2021
Merged

docs: manager-api as os service #1885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eaccb5d
docs: manager-api as a service
bisakhmondal May 10, 2021
34d0ecb
docs: update centos docs
bisakhmondal May 10, 2021
4d6f572
null
bisakhmondal May 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/en/latest/deploy-with-rpm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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/
```
31 changes: 29 additions & 2 deletions docs/en/latest/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down