interaction/nginx-proxy-redirect

一个Nginx反向代理与重定向服务器，通过简化的config.yml文件配置常用功能，支持反向代理、301/302重定向，建议配合Traefik使用以实现Let's Encrypt自动化SSL。

0 次下载activeinteraction镜像

nginx-proxy-redirect

镜像概述与主要用途

nginx-proxy-redirect 是一个基于Nginx的反向代理与重定向服务器，旨在通过简化的 config.yml 文件快速配置常见需求。它设计为可配合 Traefik 使用，以实现Let's Encrypt自动化SSL证书管理。该镜像通过模板化的 server 块和 location 块，降低了Nginx配置的复杂度，适合快速实现反向代理或重定向功能。

核心功能与特性

简化配置：通过 config.yml 文件定义 server 块和 location 块，无需直接编写Nginx配置文件
灵活路由：支持反向代理（proxy: true）和重定向（proxy: false）两种模式
重定向类型：可配置301永久重定向（permanent: true）或302临时重定向（permanent: false）
正则支持：locations规则和重定向URL支持正则表达式及捕获组，顺序影响匹配结果
自定义参数：支持按server块覆盖 client_max_body_size，按location块自定义代理Host头
环境变量配置：通过环境变量调整Nginx核心参数（如工作进程数、默认请求体大小）
内置优化：包含日志到stdout/stderr、gzip压缩、WebSockets支持、标准代理头（X-Forwarded-Proto/For）及私有IP代理信任等预设配置

使用场景与适用范围

反向代理需求：需将不同域名/路径路由至后端服务（如多微服务前端路由）
重定向场景：域名迁移（301）、临时维护跳转（302）、路径重写（如去除URL前缀）
简化配置：非专业Nginx用户通过YAML快速实现基础代理/重定向功能
SSL配合：作为Traefik后端，利用其自动申请Let's Encrypt证书能力

使用方法与配置说明

1. config.yml配置

核心配置文件，定义一个或多个 server 块，每个 server 包含多个 location 块。

字段说明

层级	字段	说明	默认值
server	server_name	Nginx `server_name` 指令，定义匹配的域名	-
server	client_max_body_size	Nginx `client_max_body_size` 指令，限制请求体大小	继承全局配置
server.locations	rule	Nginx `location` 指令，定义匹配的路径	`/`
server.locations	url	目标地址，用于 `proxy_pass`（代理）或 `return`（重定向）指令	-
server.locations	permanent	是否301永久重定向（true）或302临时重定向（false）	false
server.locations	proxy	是否启用反向代理（true）或重定向（false）	false
server.locations	proxy_hostname	代理请求时设置的Host头	`$http_host`

配置示例

yaml
- server_name: example.com [***]
  client_max_body_size: 20m
  locations:
  - rule: /old-path
    url: [***]
    permanent: true  # 301重定向
  - rule: ~^/api/(.*)$  # 正则表达式匹配，捕获组
    url: [***]  # 使用捕获组重写路径
    proxy: true  # 反向代理
    proxy_hostname: backend-service  # 自定义Host头

2. 环境变量配置

通过环境变量调整Nginx全局参数：

环境变量	说明	默认值
`CLIENT_MAX_BODY_SIZE`	`http` 块中的默认请求体大小限制，可被 `server` 块中的配置覆盖	`10m`
`WORKER_PROCESSES`	Nginx工作进程数，设为 `auto` 时按CPU核心数自动调整	`1`

3. 硬编码配置

镜像内置以下无需手动配置的优化项：

日志输出至stdout/stderr（适合容器环境）
启用gzip压缩（针对常见文本格式如text/css、application/json等）
支持WebSockets（通过 Connection: upgrade 和 Upgrade 头处理）
传递客户端真实协议头 X-Forwarded-Proto
设置客户端真实IP头 X-Forwarded-For
信任私有IP段代理服务器（避免IP被代理覆盖）

4. 自定义配置

如需扩展Nginx配置，可在挂载目录中创建 conf.d 文件夹，添加 .conf 文件。这些文件会被自动包含到Nginx的 http 块末尾，用于定义自定义 server 块或补充配置。

路径：/opt/nginx-proxy-redirect/data/conf.d/*.conf

示例

Docker运行示例

bash
docker run -d \
  -p 80:80 \
  -v $(pwd)/data:/opt/nginx-proxy-redirect/data \  # 挂载配置目录
  -e WORKER_PROCESSES=auto \
  -e CLIENT_MAX_BODY_SIZE=50m \
  nginx-proxy-redirect

docker-compose.yml示例

yaml
version: '3'
services:
  nginx-proxy-redirect:
    image: nginx-proxy-redirect
    ports:
      - "80:80"
    volumes:
      - ./data:/opt/nginx-proxy-redirect/data  # 本地data目录包含config.yml和conf.d
    environment:
      - WORKER_PROCESSES=auto
      - CLIENT_MAX_BODY_SIZE=50m
    restart: unless-stopped