unitoo/http-error-catcher

Traefik Unitoo风格HTTP错误中间件

镜像概述

该Docker镜像提供了一个Traefik中间件，用于捕获HTTP错误响应（如404、500等状态码），并返回符合Unitoo品牌设计规范的自定义错误页面，以提升用户体验并保持品牌一致性。

核心功能与特性

• HTTP错误处理：支持捕获常见HTTP错误状态码，自动拦截错误响应
• Unitoo风格页面：内置符合Unitoo品牌设计标准的错误页面，包含统一的视觉元素和交互设计
• Traefik集成：遵循Traefik中间件规范，可直接集成到Traefik的中间件链中
• 轻量级设计：基于高效基础镜像构建，资源占用低，响应迅速

使用场景

适用于采用Traefik作为反向代理的Web服务环境，尤其适合需要统一错误页面风格、强化品牌形象的Unitoo相关应用或服务。

使用方法

前提条件

• 已部署Traefik服务（v2.x及以上版本）
• 熟悉Traefik中间件配置方式

配置步骤

1. 在Traefik中定义中间件

在Traefik的动态配置（如Docker标签、File Provider等）中定义使用该中间件：

Docker标签示例：

yaml
services:
  your-service:
    # ... 其他配置 ...
    labels:
      - "traefik.http.middlewares.unitoo-errors-middleware.plugin.unitoo-errors=true"
      - "traefik.http.routers.your-router.middlewares=unitoo-errors-middleware@docker"

File Provider示例（traefik.yml或动态配置文件）：

yaml
http:
  middlewares:
    unitoo-errors-middleware:
      plugin:
        unitoo-errors: {}  # 可根据需要添加配置参数

  routers:
    your-router:
      # ... 其他路由配置 ...
      middlewares:
        - unitoo-errors-middleware

2. 启动服务

确保Traefik已加载该中间件配置，重启或重载Traefik使配置生效。

配置参数

目前该中间件的默认配置已包含基础功能，具体可配置参数（如自定义错误码映射、页面内容调整等）请参考官方文档获取最新信息。

部署示例

以下是一个简单的docker-compose部署示例，集成Traefik与该错误中间件：

yaml
version: '3.8'

services:
  traefik:
    image: traefik:v2.10
    command:
      - "--providers.docker=true"
      - "--providers.docker.exposedbydefault=false"
    ports:
      - "80:80"
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    # ... 其他Traefik配置 ...

  your-service:
    image: your-app-image
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.your-service.rule=Host(`example.com`)"
      - "traefik.http.routers.your-service.entrypoints=web"
      - "traefik.http.middlewares.unitoo-errors.plugin.unitoo-errors=true"
      - "traefik.http.routers.your-service.middlewares=unitoo-errors@docker"

注意事项

• 确保Traefik已启用插件支持（部分版本需显式配置）
• 该中间件需在其他可能返回错误的中间件之后配置，以确保错误响应被正确拦截
• 如需自定义错误页面内容，可通过挂载卷替换镜像内的静态资源文件