mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-02 20:17:35 +08:00
doc: updated.
This commit is contained in:
Yuansheng
YuanSheng Wang
parent
0969751798
commit
239d202469
@ -126,7 +126,7 @@ Congratulations, you have already installed APISIX successfully.
|
||||
|
||||
## Development Manual of APISIX
|
||||
|
||||
If you are a developer, you can view the [dev manual](doc/dev-manual.md) for more detailed information.
|
||||
If you are a developer, you can view the [dev manual](doc/dev-manual.md) for more details.
|
||||
|
||||
## Quickstart
|
||||
|
||||
@ -149,7 +149,7 @@ APISIX has the built-in dashboard，open `http://127.0.0.1:9080/apisix/dashboard
|
||||
|
||||
Do not need to fill the user name and password, log in directly.
|
||||
|
||||
dashboard only allow `127.0.0.0/24` by default, and you can modify `allow_admin` in `conf/config.yaml` by yourself, to add more IPs.
|
||||
Dashboard allow any remote IP by default, and you can modify `allow_admin` in `conf/config.yaml` by yourself, to list the list of IPs allowed to access.
|
||||
|
||||
## Benchmark
|
||||
|
||||
|
||||
@ -143,8 +143,7 @@ sudo apisix start
|
||||
APISIX 内置了 dashboard，使用浏览器打开 `http://127.0.0.1:9080/apisix/dashboard` 即可使用，
|
||||
不用填写用户名和密码，直接登录。
|
||||
|
||||
dashboard 默认只放行了 `127.0.0.0/24` 的本地 IP，其他地址禁止访问。
|
||||
你可以自行修改 `conf/config.yaml` 中的 `allow_admin` 字段，来增加更多可以访问 dashboard 的 IP。
|
||||
Dashboard 默认允许任何 IP 访问。你可以自行修改 `conf/config.yaml` 中的 `allow_admin` 字段，指定允许访问 dashboard 的 IP 列表。
|
||||
|
||||
## 性能测试
|
||||
|
||||
|
||||
@ -5,8 +5,14 @@
|
||||
如果你是开发人员，可以通过下面的命令快速搭建本地开发环境。
|
||||
|
||||
```shell
|
||||
# clone project
|
||||
git clone git@github.com:iresty/apisix.git
|
||||
cd apisix
|
||||
|
||||
# init submodule
|
||||
git submodule update --init --recursive
|
||||
|
||||
# install dependency
|
||||
make dev
|
||||
```
|
||||
|
||||
@ -19,21 +25,37 @@ make dev
|
||||
```shell
|
||||
$ tree -L 2 -d apisix
|
||||
apisix
|
||||
├── benchmark
|
||||
│ ├── fake-apisix
|
||||
│ └── server
|
||||
├── bin
|
||||
├── conf
|
||||
├── deps # 依赖的 Lua 和动态库，放在了这里
|
||||
│ └── cert
|
||||
├── dashboard
|
||||
│ ├── css
|
||||
│ ├── fonts
|
||||
│ ├── img
|
||||
│ ├── js
|
||||
│ └── tinymce
|
||||
├── deps # 依赖的 Lua 和动态库，放在了这里
|
||||
│ ├── lib64
|
||||
│ └── share
|
||||
├── doc
|
||||
│ └── images
|
||||
│ ├── images
|
||||
│ └── plugins
|
||||
├── logs
|
||||
├── lua
|
||||
│ └── apisix
|
||||
├── rockspec
|
||||
├── t
|
||||
│ ├── admin
|
||||
│ ├── config-center-yaml
|
||||
│ ├── core
|
||||
│ ├── lib
|
||||
│ ├── node
|
||||
│ └── plugin
|
||||
│ ├── plugin
|
||||
│ ├── router
|
||||
│ └── servroot
|
||||
└── utils
|
||||
```
|
||||
|
||||
@ -45,13 +67,15 @@ Makefile rules:
|
||||
|
||||
help: Show Makefile rules.
|
||||
dev: Create a development ENV
|
||||
check: Check Lua srouce code
|
||||
dev_r3: Create a development ENV for r3
|
||||
check: Check Lua source code
|
||||
init: Initialize the runtime environment
|
||||
run: Start the apisix server
|
||||
stop: Stop the apisix server
|
||||
clean: Remove generated files
|
||||
reload: Reload the apisix server
|
||||
install: Install the apisix
|
||||
test: Run the test case
|
||||
```
|
||||
|
||||
|
||||
|
||||
@ -7,6 +7,11 @@ If you are a developer, you can set up a local development environment with the
|
||||
```shell
|
||||
git clone git@github.com:iresty/apisix.git
|
||||
cd apisix
|
||||
|
||||
# init submodule
|
||||
git submodule update --init --recursive
|
||||
|
||||
# install dependency
|
||||
make dev
|
||||
```
|
||||
|
||||
@ -19,21 +24,37 @@ The following is the expected development environment directory structure:
|
||||
```shell
|
||||
$ tree -L 2 -d apisix
|
||||
apisix
|
||||
├── benchmark
|
||||
│ ├── fake-apisix
|
||||
│ └── server
|
||||
├── bin
|
||||
├── conf
|
||||
├── deps # dependent Lua and dynamic libraries
|
||||
│ └── cert
|
||||
├── dashboard
|
||||
│ ├── css
|
||||
│ ├── fonts
|
||||
│ ├── img
|
||||
│ ├── js
|
||||
│ └── tinymce
|
||||
├── deps # dependent Lua and dynamic libraries
|
||||
│ ├── lib64
|
||||
│ └── share
|
||||
├── doc
|
||||
│ └── images
|
||||
│ ├── images
|
||||
│ └── plugins
|
||||
├── logs
|
||||
├── lua
|
||||
│ └── apisix
|
||||
├── rockspec
|
||||
├── t
|
||||
│ ├── admin
|
||||
│ ├── config-center-yaml
|
||||
│ ├── core
|
||||
│ ├── lib
|
||||
│ ├── node
|
||||
│ └── plugin
|
||||
│ ├── plugin
|
||||
│ ├── router
|
||||
│ └── servroot
|
||||
└── utils
|
||||
```
|
||||
|
||||
@ -45,13 +66,15 @@ Makefile rules:
|
||||
|
||||
help: Show Makefile rules.
|
||||
dev: Create a development ENV
|
||||
check: Check Lua srouce code
|
||||
dev_r3: Create a development ENV for r3
|
||||
check: Check Lua source code
|
||||
init: Initialize the runtime environment
|
||||
run: Start the apisix server
|
||||
stop: Stop the apisix server
|
||||
clean: Remove generated files
|
||||
reload: Reload the apisix server
|
||||
install: Install the apisix
|
||||
test: Run the test case
|
||||
```
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user