# apisixWeb

**Repository Path**: dyrnq/apisixWeb

## Basic Information

- **Project Name**: apisixWeb
- **Description**: apisixWeb是一个Apisix的webui界面，该项目使用apisix的管理API（即数据面API）实现了对apisix实例的业务操作!
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://gitee.com/opensolon/solon
- **GVP Project**: No

## Statistics

- **Stars**: 69
- **Forks**: 19
- **Created**: 2023-05-12
- **Last Updated**: 2025-06-11

## Categories & Tags

**Categories**: api-gateway

**Tags**: apisix, apisix-dashboard, Gateway, solon

## README

# apisixWeb

<img src="https://a.dyrnq.com/apisixWeb/images/logo.png" alt="apisixWeb" width="300" height="300">

<!-- TOC -->

- [apisixWeb](#apisixweb)
  - [描述](#描述)
  - [特色](#特色)
  - [docker](#docker)
  - [构建](#构建)
  - [运行](#运行)
    - [安装 jdk](#安装-jdk)
    - [安装 apisix](#安装-apisix)
    - [运行 apisixWeb](#运行-apisixweb)

<!-- /TOC -->

## 描述

apisixWeb是一个Apisix的webui界面，该项目使用apisix的管理API（即数据面API）实现了对apisix实例的业务操作!

最终目的是使用Apisix来接管网站的流量端口80和443。使用最佳实践进行网站流量管理，既高效又方便。

灵感来自 [nginxWebUI](https://gitee.com/cym1102/nginxWebUI)。

## 特色

- 增加，删除，修改 Routes，StreamRoutes，SSL... 基于Apisix数据面APIs。
- 多个Apisix实例管理。
- 批量操作。
- 一键删除。
- 原始数据导入导出。
- 使用acme.sh实现https证书的申请（DNS-01）。
- 使用acme4j实现https证书的申请（HTTP-01）。
- 自签名证书管理。
- 过期证书自动重新申请。
- 使用yaml文件来实现规则的部署。

<img src="https://a.dyrnq.com/apisixWeb/images/web/Screenshot%202023-09-23%20at%2010-10-33%20apisixWeb.png" alt="apisixWeb" width="589" height="310">

<img src="https://a.dyrnq.com/apisixWeb/images/web/Screenshot%202023-09-23%20at%2010-11-05%20apisixWeb.png" alt="apisixWeb" width="589" height="310">

<img src="https://a.dyrnq.com/apisixWeb/images/web/Screenshot%202023-09-23%20at%2010-11-24%20apisixWeb.png" alt="apisixWeb" width="589" height="310">

<img src="https://a.dyrnq.com/apisixWeb/images/web/Screenshot%202023-09-23%20at%2010-11-46%20apisixWeb.png" alt="apisixWeb" width="589" height="310">

## docker

```bash
# 创建持久化目录 for apisixWeb
mkdir -p $HOME/apisixWeb
chown -R 1000:1000 $HOME/apisixWeb
# 产生一个新的jwt secret 替换默认的 IDP32XTulsVIUZU+srFEUC9Lhu1wV+nd8iCJPoPA2zSFVAtWhCgpMEymxy5wFAZKMB9yROX31UjDzjwL66r1RA==
docker run -it --rm --entrypoint="" dyrnq/apisixweb:latest-jre21 bash -c "java -cp /app/apisixWeb.jar cli jwt"

# 删除 旧的 apisixweb 容器
docker rm -f apisixweb >/dev/null 2>&1

# 启动 新的 apisixweb 容器
docker run \
--name apisixweb \
-d \
--restart always \
-v $HOME/apisixWeb:/app/apisixWeb \
-p 8080: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
```

## 构建

```bash
git clone git@gitee.com:dyrnq/apisixWeb.git
cd apisixWeb
./mvnw -s ./settings.xml clean package -Dmaven.test.skip=true
```

## 运行

### 安装 jdk

Ubuntu

```bash
apt update
apt install openjdk-8-jdk -y
# apt install openjdk-11-jdk -y
```

Centos

```bash
yum install -y java-1.8.0-openjdk
# yum install -y java-11-openjdk
```

### 安装 apisix

<https://apisix.apache.org/docs/apisix/installation-guide/>

### 运行 apisixWeb

```bash
wget https://a.dyrnq.com/apisixWeb/f/latest/apisixWeb.jar
```

```bash
java -jar apisixWeb.jar
```

使用命令行方式的示例

```bash
java \
-server \
-Xms512m \
-Xmx512m \
-Djava.awt.headless=true \
-Dfile.encoding=UTF-8 \
-Duser.timezone=Asia/Shanghai \
-Djava.net.preferIPv4Stack=true \
-jar apisixWeb.jar \
--server.port=3333 \
--server.session.timeout=172800
```

使用systemd部署的示例

```bash
vim /etc/systemd/system/apisixWeb.service
```

```bash
[Unit]
Description=apisixWeb
After=syslog.target network.target

[Service]
Type=simple
Environment="PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/local/java/bin"
TimeoutStartSec=30
TimeoutStopSec=20
ExecStart=/usr/bin/java \
  -server \
  -Xms512m \
  -Xmx512m \
  -Dfile.encoding=UTF-8 \
  -Duser.timezone=Asia/Shanghai \
  -Djava.net.preferIPv4Stack=true \
  -jar /data/apisixWeb/apisixWeb.jar \
  --server.port=3333 \
  --server.session.timeout=172800
ExecStop=/bin/kill -s TERM $MAINPID
Restart=always
LimitNOFILE=infinity
LimitNPROC=infinity
LimitCORE=infinity
TasksMax=infinity
[Install]
WantedBy=multi-user.target
```

```bash
systemctl daemon-reload
if systemctl is-active apisixWeb &>/dev/null; then
    systemctl restart apisixWeb
else
    systemctl enable --now apisixWeb
fi
systemctl status -l apisixWeb --no-pager
```

更改默认 session jwt secret

```bash
java -cp apisixWeb.jar cli jwt
```

将参数 `--jwt.secret=your-secret` 增加到 `java -jar`。

参数描述 (都是可选的）

| 参数                         | 含义                               | 默认值          |
|------------------------------|------------------------------------|-----------------|
| --server.port                | 端口                               | 8080            |
| --project.home               | 数据目录                           | $HOME/apisixWeb |
| --spring.database.type       | 可选 h2，mysql，sqlite，postgresql | h2              |
| --spring.datasource.url      | 数据源 url                         |                 |
| --spring.datasource.username | 数据源 username                    |                 |
| --spring.datasource.password | 数据源 password                    |                 |

Supports environment variables

| Variable Name                        | Meaning                                       | Default Value     |
|--------------------------------------|-----------------------------------------------|-------------------|
| SERVER_PORT                          | Server port                                   | 8080              |
| PROJECT_HOME                         | Data directory                                | $HOME/apisixWeb   |
| SPRING_DATABASE_TYPE                 | Database type (h2, mysql, sqlite, postgresql) | h2                |
| SPRING_DATASOURCE_URL                | Database URL                                  |                   |
| SPRING_DATASOURCE_USERNAME           | Database username                             |                   |
| SPRING_DATASOURCE_PASSWORD           | Database password                             |                   |
| JWT_SECRET                           | jwt secret                                    |                   |
| SEVER_SESSION_TIMEOUT                | session timeout                               | 7200              |