Skip to content

Commit a02f34c

Browse files
authored
doc: Add more examples to builtin-plugin-url.md files (#459)
1 parent 68fd6f6 commit a02f34c

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed

src/content/docs/latest/en/ops/how-tos/builtin-plugin-url.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,34 @@ helm upgrade higress --version ${higress_version} -n higress-system higress.io/h
6464

6565
Directly modify the `compose/env/console.env` file and add the corresponding environment variable. Note that the `$` character in the environment variable value needs to be escaped as `$$`, otherwise it will not take effect properly, for example:
6666

67+
**Example 1:**
68+
6769
```bash
6870
HIGRESS_ADMIN_WASM_PLUGIN_CUSTOM_IMAGE_URL_PATTERN=http://192.168.1.1:8080/plugins/$${name}.wasm
6971
```
7072

73+
**Example 2:**
74+
75+
```bash
76+
HIGRESS_ADMIN_WASM_PLUGIN_CUSTOM_IMAGE_URL_PATTERN=oci://hub.example.com/wasm-plugins/$${name}:$${version}
77+
```
78+
7179
### Configuration Method for Docker All-in-One Deployment
7280

7381
Add the `-e` parameter to the docker command when starting the container to specify the environment variable. Note that the `$` character in the environment variable value needs to be escaped as `\$`, otherwise it will not take effect properly, for example:
7482

83+
**Example 1:**
84+
7585
```bash
7686
-e HIGRESS_ADMIN_WASM_PLUGIN_CUSTOM_IMAGE_URL_PATTERN=http://192.168.1.1:8080/plugins/\${name}.wasm
7787
```
7888

89+
**Example 2:**
90+
91+
```bash
92+
-e HIGRESS_ADMIN_WASM_PLUGIN_CUSTOM_IMAGE_URL_PATTERN=oci://hub.example.com/wasm-plugins/\${name}:\${version}
93+
```
94+
7995
### Notes
8096

8197
The above configuration will not affect plugin configurations that have already been saved. If you need to modify the image URLs in these plugin configurations, you can make targeted modifications on the plugin configuration page of the Higress Console.
@@ -116,14 +132,30 @@ helm upgrade higress --version ${higress_version} -n higress-system higress.io/h
116132

117133
Directly modify the `compose/env/controller.env` file and add the corresponding environment variable. Note that the `$` character in the environment variable value needs to be escaped as `$$`, otherwise it will not take effect properly, for example:
118134

135+
**Example 1:**
136+
119137
```bash
120138
MCP_SERVER_WASM_IMAGE_URL=http://192.168.1.1:8080/plugins/mcp-server.wasm
121139
```
122140

141+
**Example 2:**
142+
143+
```bash
144+
MCP_SERVER_WASM_IMAGE_URL=oci://hub.example.com/wasm-plugins/mcp-server:0.0.1
145+
```
146+
123147
### Configuration Method for Docker All-in-One Deployment
124148

125149
Add the `-e` parameter to the docker command when starting the container to specify the environment variable. Note that the `$` character in the environment variable value needs to be escaped as `\$`, otherwise it will not take effect properly, for example:
126150

151+
**Example 1:**
152+
127153
```bash
128154
-e MCP_SERVER_WASM_IMAGE_URL=http://192.168.1.1:8080/plugins/mcp-server.wasm
155+
```
156+
157+
**Example 2:**
158+
159+
```bash
160+
-e MCP_SERVER_WASM_IMAGE_URL=oci://hub.example.com/wasm-plugins/mcp-server:0.0.1
129161
```

src/content/docs/latest/zh-cn/ops/how-tos/builtin-plugin-url.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,18 +64,34 @@ helm upgrade higress --version ${higress_version} -n higress-system higress.io/h
6464

6565
直接修改 `compose/env/console.env` 文件,添加对应的环境变量即可。需要注意的是,环境变量取值中的 `$` 字符需要转义成 `$$`,否则将无法正常生效,例如:
6666

67+
**例 1:**
68+
6769
```bash
6870
HIGRESS_ADMIN_WASM_PLUGIN_CUSTOM_IMAGE_URL_PATTERN=http://192.168.1.1:8080/plugins/$${name}.wasm
6971
```
7072

73+
**例 2:**
74+
75+
```bash
76+
HIGRESS_ADMIN_WASM_PLUGIN_CUSTOM_IMAGE_URL_PATTERN=oci://hub.example.com/wasm-plugins/$${name}:$${version}
77+
```
78+
7179
### Docker All-in-One 部署方式配置方法
7280

7381
在启动容器的 docker 命令中添加 `-e` 参数来指定环境变量。需要注意的是,环境变量取值中的 `$` 字符需要转义成 `\$`,否则将无法正常生效,例如:
7482

83+
**例 1:**
84+
7585
```bash
7686
-e HIGRESS_ADMIN_WASM_PLUGIN_CUSTOM_IMAGE_URL_PATTERN=http://192.168.1.1:8080/plugins/\${name}.wasm
7787
```
7888

89+
**例 2:**
90+
91+
```bash
92+
-e HIGRESS_ADMIN_WASM_PLUGIN_CUSTOM_IMAGE_URL_PATTERN=oci://hub.example.com/wasm-plugins/\${name}:\${version}
93+
```
94+
7995
### 注意事项
8096

8197
以上配置不会影响已经保存的插件配置。如果需要修改这些插件配置中的镜像地址,可以在 Higress Console 的插件配置页面进行针对性修改。
@@ -116,14 +132,30 @@ helm upgrade higress --version ${higress_version} -n higress-system higress.io/h
116132

117133
直接修改 `compose/env/controller.env` 文件,添加对应的环境变量即可。需要注意的是,环境变量取值中的 `$` 字符需要转义成 `$$`,否则将无法正常生效,例如:
118134

135+
**例 1:**
136+
119137
```bash
120138
MCP_SERVER_WASM_IMAGE_URL=http://192.168.1.1:8080/plugins/mcp-server.wasm
121139
```
122140

141+
**例 2:**
142+
143+
```bash
144+
MCP_SERVER_WASM_IMAGE_URL=oci://hub.example.com/wasm-plugins/mcp-server:0.0.1
145+
```
146+
123147
### Docker All-in-One 部署方式配置方法
124148

125149
在启动容器的 docker 命令中添加 `-e` 参数来指定环境变量。需要注意的是,环境变量取值中的 `$` 字符需要转义成 `\$`,否则将无法正常生效,例如:
126150

151+
**例 1:**
152+
127153
```bash
128154
-e MCP_SERVER_WASM_IMAGE_URL=http://192.168.1.1:8080/plugins/mcp-server.wasm
129155
```
156+
157+
**例 2:**
158+
159+
```bash
160+
-e MCP_SERVER_WASM_IMAGE_URL=oci://hub.example.com/wasm-plugins/mcp-server:0.0.1
161+
```

0 commit comments

Comments
 (0)