dyrnq/apisixweb

APISIX Web管理工具Docker镜像文档

镜像概述

本镜像为APISIX Web管理工具的Docker化部署包，基于JRE21运行环境，提供Web界面用于管理APISIX相关配置。支持通过环境变量自定义服务参数，包括端口、JWT认证密钥、会话超时等，并通过卷挂载实现配置数据持久化，适用于需要可视化管理APISIX服务的场景。

核心功能特性

• 运行环境：基于JRE21构建，确保Java应用稳定运行
• JWT认证：支持通过JWT_SECRET配置JWT密钥，保障接口访问安全
• 灵活配置：可自定义服务端口（SERVER_PORT）、会话超时（SERVER_SESSION_TIMEOUT）及时区（TZ）
• 数据持久化：通过挂载卷到/app/apisixWeb目录，实现配置数据持久化存储
• Java参数定制：支持通过JAVA_OPTS调整JVM参数（如内存分配、编码设置等）
• 高可用性：默认配置容器自动重启（--restart always）及自动拉取最新镜像（--pull always）

使用场景

• APISIX服务的可视化管理与配置操作
• 需要持久化保存管理配置数据的生产/测试环境
• 需自定义认证密钥、服务端口或JVM运行参数的场景
• 对服务可用性有要求，需要自动恢复和版本更新的部署环境

使用方法

前置准备

1. 创建本地数据目录并设置权限（用于持久化存储配置数据）：

bash
mkdir -p $HOME/apisixWeb
chown -R 1000:1000 $HOME/apisixWeb

生成JWT密钥

通过容器内置命令生成JWT密钥（用于JWT认证）：

bash
docker run -it --rm --entrypoint="" dyrnq/apisixweb:latest-jre21 bash -c "java -cp /app/apisixWeb.jar cli jwt"

执行后输出类似以下格式的密钥，记录该密钥用于后续配置（示例密钥：IDP32XTulsVIUZU+srFEUC9Lhu1wV+nd8iCJPoPA2zSFVAtWhCgpMEymxy5wFAZKMB9yROX31UjDzjwL66r1RA==）。

启动容器

标准启动命令

先停止并清理旧容器（若存在），再启动新容器：

bash
docker rm -f apisixweb >/dev/null 2>&1
docker run \
--name apisixweb \
-d \
--restart always \
--pull always \
-v $HOME/apisixWeb:/app/apisixWeb \
-p 18080:8080 \
-e TZ="Asia/Shanghai" \
-e SERVER_PORT="8080" \
-e SERVER_SESSION_TIMEOUT="172800" \
-e JWT_SECRET="IDP32XTulsVIUZU+srFEUC9Lhu1wV+nd8iCJPoPA2zSFVAtWhCgpMEymxy5wFAZKMB9yROX31UjDzjwL66r1RA==" \
-e JAVA_OPTS="-server -Xms512m -Xmx512m -Djava.awt.headless=true -Dfile.encoding=UTF-8 -Duser.timezone=Asia/Shanghai -Djava.net.preferIPv4Stack=true" \
dyrnq/apisixweb:latest-jre21

核心参数说明

环境变量配置说明

访问服务

容器启动后，通过宿主机IP:***访问APISIX Web管理界面，例如：
http://localhost:18080（本地访问）或http://[宿主机IP]:18080（远程访问）。

注意事项

1. 目录权限：确保本地目录$HOME/apisixWeb权限正确（用户ID:1000，组ID:1000），避免容器无权限读写数据。
2. 密钥安全：JWT_SECRET需通过cli jwt命令生成，避免使用示例密钥，防止安全风险。
3. 资源配置：根据实际需求调整JAVA_OPTS中的内存参数（-Xms初始内存、-Xmx最大内存），避免资源不足或浪费。
4. 版本更新：重新执行启动命令时，--pull always会自动拉取最新镜像，实现版本更新。