Skip to content

Commit 902defc

Browse files
authored
docs: improve quick start document (#213)
1 parent 9c181d8 commit 902defc

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

docs/zh/quick-start.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,10 @@ public class CheckTokenFilter implements PluginFilter {
2222
}
2323

2424
@Override
25-
public Mono<Void> filter(HttpRequest request, HttpResponse response, PluginFilterChain chain) {
25+
public void filter(HttpRequest request, HttpResponse response, PluginFilterChain chain) {
2626
/*
2727
* todo your business here
2828
*/
29-
30-
31-
return chain.filter(request, response);
3229
}
3330
}
3431
```
@@ -48,18 +45,17 @@ apisix-java-plugin-runner 与 APISIX 用 `Unix Domain Socket` 进行进程间通
4845
构建完成,你会在 `dist` 目录看见构建产物
4946

5047
```
51-
apache-apisix-java-plugin-runner-0.1.0-bin.tar.gz
48+
apache-apisix-java-plugin-runner-${your_plugin_version}-bin.tar.gz
5249
```
5350

5451
`dist`目录添加`Dockerfile`文件
5552

5653
```dockerfile
57-
FROM apache/apisix:${version}-alpine
58-
59-
RUN sed -i "s/dl-cdn.alpinelinux.org/mirrors.aliyun.com/g" /etc/apk/repositories && apk add --no-cache openjdk8-jre
54+
FROM apache/apisix:${version}-debian
6055

61-
ADD apache-apisix-java-plugin-runner-0.1.0-bin.tar.gz /usr/local/
56+
RUN apt -y install openjdk-11-jdk
6257

58+
ADD apache-apisix-java-plugin-runner-${your_plugin_version}-SNAPSHOT-bin.tar.gz /usr/local/
6359
```
6460

6561
然后构建容器镜像
@@ -73,11 +69,20 @@ ADD apache-apisix-java-plugin-runner-0.1.0-bin.tar.gz /usr/local/
7369

7470
```yaml
7571
ext-plugin:
76-
cmd: ['java', '-jar', '-Xmx4g', '-Xms4g', '/path/to/apisix-runner-bin/apisix-java-plugin-runner.jar']
72+
cmd: ['java', '-jar', '-Xmx4g', '-Xms4g', '/usr/local/apisix-runner-bin/apisix-java-plugin-runner.jar']
7773
```
7874
7975
构建完成的 `apache/apisix:${version}-alpine-with-java-plugin` 镜像内即包含 APISIX 与 apisix-java-plugun-runner。
8076

77+
### 调试
78+
如果需要调试插件, 可以将上述 ext-plugin 配置中添加调试参数:
79+
```yaml
80+
ext-plugin:
81+
cmd: ['java', '-jar', '-Xmx4g', '-Xms4g','-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005', '/usr/local/apisix-runner-bin/apisix-java-plugin-runner.jar']
82+
```
83+
84+
就可以通过 Docker 的 5005 端口远程调试插件。
85+
8186
### 使用插件
8287

8388
配置路由

0 commit comments

Comments
 (0)