casualsimulation/aux-redirector

aux URL重定向服务镜像文档

镜像概述

本镜像是一个轻量级Web服务，专注于URL重定向功能，核心作用是将旧式aux格式的URL自动转发至新版本URL。通过自动化重定向机制，解决系统升级或URL结构调整后旧地址失效问题，确保用户访问旧URL时可无缝跳转至新地址，避免404错误，提升服务连续性和用户体验。

核心功能和特性

核心功能

• URL重定向：接收旧式aux URL请求，自动返回重定向响应至对应新版本URL。

主要特性

• 轻量级设计：基于精简运行时环境，资源占用低，适合边缘节点或轻量部署场景。
• 快速响应：优化请求处理逻辑，平均响应时间<10ms，确保用户访问无感知跳转。
• 配置灵活：支持通过环境变量或配置文件自定义重定向规则（如目标路径、状态码等）。
• 标准兼容：遵循HTTP/HTTPS协议规范，支持301（永久重定向）和302（临时重定向）状态码。
• 易于集成：可直接部署为独立服务，或与反向代理（如Nginx）、负载均衡器配合使用。

使用场景和适用范围

适用场景

• 系统升级迁移：网站或API服务URL结构调整后，需保留旧aux格式URL的兼容性。
• 旧接口兼容：API版本迭代后，确保第三方调用旧aux接口时自动路由至新版本接口。
• 域名/路径调整：主域名变更或子路径重组后，维持旧aux URL的访问有效性。
• 临时过渡需求：系统重构期间，作为临时转发层，减少对前端配置的依赖。

适用范围

• 个人开发者或小型团队的轻量服务部署
• 企业内部系统URL规范统一
• 互联网服务版本迭代中的兼容性保障
• 需快速实现URL转发功能的临时场景

使用方法和配置说明

前提条件

• 已安装Docker Engine（20.10+版本推荐）
• 网络环境支持HTTP/HTTPS端口映射（默认监听80端口，HTTPS需额外配置证书）

获取镜像

从Docker镜像仓库拉取最新版本（假设镜像名为aux-url-redirector）：

bash
docker pull aux-url-redirector:latest

基本部署示例

1. 基础运行（默认配置）

使用默认参数启动服务，监听本地8080端口，将旧式aux URL重定向至预设新版本基础路径：

bash
docker run -d \
  --name aux-redirect-service \
  -p 8080:80 \
  aux-url-redirector:latest

2. 自定义重定向目标和状态码

通过环境变量指定新版本URL基础路径和重定向状态码（301永久重定向或302临时重定向）：

bash
docker run -d \
  --name aux-redirect-service \
  -p 80:80 \
  -e REDIRECT_TARGET_BASE_URL="https://new-api.example.com/v2/aux" \  # 新版本aux URL基础路径
  -e REDIRECT_STATUS_CODE=301 \  # 重定向状态码，可选301或302，默认302
  aux-url-redirector:latest

3. Docker Compose部署

创建docker-compose.yml文件，配置持久化日志和自定义网络：

yaml
version: '3'
services:
  aux-redirect:
    image: aux-url-redirector:latest
    container_name: aux-redirect-service
    ports:
      - "80:80"
    environment:
      - REDIRECT_TARGET_BASE_URL="https://new.example.com/aux"
      - REDIRECT_STATUS_CODE=301
    logging:
      driver: "json-file"
      options:
        max-size: "10m"
        max-file: "3"
    restart: unless-stopped

启动服务：docker-compose up -d

配置参数说明

环境变量

自定义重定向规则（高级配置）

若需对不同旧式aux路径设置差异化重定向目标，可通过挂载配置文件实现。创建redirect-rules.json文件：

json
{
  "/old/aux/path1": "https://new.example.com/new/path1",
  "/old/aux/path2": "https://new.example.com/new/path2"
}

启动时挂载配置文件：

bash
docker run -d \
  --name aux-redirect-service \
  -p 80:80 \
  -v $(pwd)/redirect-rules.json:/app/rules.json \  # 挂载本地规则文件至容器内
  -e USE_CUSTOM_RULES=true \  # 启用自定义规则模式
  aux-url-redirector:latest

验证与日志

• 访问验证：通过curl -I http://localhost/old/aux/path检查响应头，确认Location字段指向目标URL且状态码正确。
• 日志查看：docker logs aux-redirect-service查看请求处理日志，包含源URL、目标URL和处理状态。

注意事项

• 若启用HTTPS，需额外挂载SSL证书（如通过环境变量指定证书路径或配合反向代理实现）。
• 自定义规则模式与基础路径模式互斥，启用USE_CUSTOM_RULES=true后，REDIRECT_TARGET_BASE_URL参数将失效。
• 生产环境建议限制容器资源（如--memory=128m --cpus=0.5），避免资源过度占用。