hhftechnology/middleware-manager

Pangolin Middleware Manager

前提条件

在安装Middleware Manager之前，请确保您具备以下条件：

• 一个正常运行的Pangolin部署
• Middleware Manager与Pangolin API之间的网络连接
• 用于配置和数据持久化的目录
• 在Traefik配置目录中创建文件的适当权限

安装方法

使用Docker Compose（推荐）

部署Middleware Manager最简单的方法是将其添加到您现有的Pangolin docker-compose.yml 文件中：

yaml
middleware-manager:
  image: hhftechnology/middleware-manager:latest
  container_name: middleware-manager
  restart: unless-stopped
  volumes:
    - ./data:/data                                     # 用于数据库持久化
    - ./config/traefik/rules:/conf                     # Traefik配置将写入的位置
    - ./config/middleware-manager/templates.yaml:/app/config/templates.yaml  # 自定义模板（可选）
  environment:
    - PANGOLIN_API_URL=http://pangolin:3001/api/v1     # 指向您的Pangolin API的URL
    - TRAEFIK_CONF_DIR=/conf                           # 写入Traefik配置的目录
    - DB_PATH=/data/middleware.db                      # SQLite数据库路径
    - PORT=3456                                        # Web UI和API的端口
  ports:
    - "3456:3456"
  networks:
    - pangolin                                         # 必须与Pangolin在同一网络

将此配置添加到您的 docker-compose.yml 文件后，运行：

bash
docker compose up -d middleware-manager

手动安装

对于开发或自定义部署场景，您也可以手动安装Middleware Manager：

1. 克隆仓库：

   bash
   git clone https://github.com/hhftechnology/middleware-manager.git
   cd middleware-manager
   

2. 配置环境：

   bash
   cp .env.example .env
   # 编辑.env文件以进行特定配置
   

3. 构建并启动服务：

   bash
   make build
   ./middleware-manager
   

注意，手动安装需要Go 1.19+和Node.js 16+来构建应用程序。

配置选项

环境变量

Middleware Manager可以使用以下环境变量进行配置：

自定义中间件模板

您可以通过将 templates.yaml 文件挂载到容器来创建自定义中间件模板。此文件定义了在您的安装中可用的默认中间件：

yaml
# 示例templates.yaml
middlewares:
  - id: "security-headers"
    name: "强安全头"
    type: "headers"
    config:
      customResponseHeaders:
        Server: ""
        X-Powered-By: ""
      browserXSSFilter: true
      contentTypeNosniff: true
      customFrameOptionsValue: "SAMEORIGIN"
      forceSTSHeader: true
      stsIncludeSubdomains: true
      stsSeconds: 63072000
      
  - id: "rate-limit"
    name: "标准速率限制"
    type: "rateLimit"
    config:
      average: 100
      burst: 50

初始设置和验证

安装后，请按照以下步骤验证一切是否正常工作：

1. 访问Web UI： 打开浏览器并导航至 http://your-server:3456 您应该能看到Middleware Manager仪表板。

2. 检查资源同步： Middleware Manager应自动开始从Pangolin获取资源。导航至"资源"选项卡，查看您的资源是否已列出。

3. 验证Traefik配置： 服务运行一分钟后，检查配置的 TRAEFIK_CONF_DIR 目录中是否有名为 resource-overrides.yml 的文件。此文件将包含Middleware Manager生成的Traefik配置。

4. 测试集成：

   • 创建一个简单的中间件（如基本头信息）
   • 将其分配给资源
   • 检查配置文件是否已更新
   • 通过检查Traefik日志，验证Traefik是否已无错误加载配置

初始设置故障排除

如果在设置过程中遇到问题：

• 检查连接性：确保Middleware Manager与Pangolin之间的网络连接
• 权限：确保对Traefik配置目录有写入权限
• 配置加载：验证Traefik是否正确加载了配置
• 日志：查看Middleware Manager容器的日志以获取错误消息：

  bash
  docker compose logs middleware-manager
  

• 网络：确保Pangolin和Middleware Manager在Docker中处于同一网络