adamkdean/redirect

adamkdean/redirect

adamkdean/redirect 是 nginx-proxy 的轻量级辅助容器，可轻松实现主机名重定向（例如非 www 到 www）。

版本

• latest、1.2、1.2.3：当前版本
• 1.1、1.1.0：多主机前版本（2021年4月4日及之前）

使用方法（独立运行）

容器可作为独立容器运行，支持两种模式：所有请求重定向或基于每个主机的请求重定向。

单主机模式

以单主机模式运行时，只需提供重定向目标位置，可选状态码和URL保留标志。此时，所有进入80端口的请求将被重定向到指定位置。

bash
docker run \
  --detach \
  --publish 80:80 \
  --env REDIRECT_STATUS_CODE=307 \
  --env REDIRECT_LOCATION="http://www.example.com" \
  --env PRESERVE_URL=true \
  adamkdean/redirect

多主机模式

通过提供映射源主机到目标的配置文件，可运行多主机模式，还可选择性覆盖状态码和URL保留标志。默认主机文件位置为 /etc/redirect/hosts.json，可通过设置 HOSTS_FILE_PATH 覆盖。

例如，可省略单主机模式中的环境变量，仅挂载配置文件：

bash
docker run \
  --detach \
  --publish 80:80 \
  --volume $(pwd)/hosts.json:/etc/redirect/hosts.json \
  adamkdean/redirect

其中 hosts.json 是包含配置选项数组的JSON文件：

json
[
  {
    "source": "example.com",
    "destination": "www.example.com",
    "preserveUrl": true
  },
  {
    "source": "another-example.com",
    "destination": "https://www.another-example.com",
    "statusCode": 303
  }
]

source 和 destination 为必填项，preserveUrl（默认：false）和 statusCode（默认：307）为可选项。

若目标未指定协议，将使用当前请求协议。若在 nginx-proxy 后运行，协议将为 http，可能增加额外跳转。

覆盖主机文件路径

可使用 HOSTS_FILE_PATH 覆盖主机文件路径：

bash
docker run \
  --detach \
  --publish 80:80 \
  --env HOSTS_FILE_PATH=/var/config.json \
  --volume $(pwd)/hosts.json:/var/config.json \
  adamkdean/redirect

使用方法（与 nginx-proxy 配合）

与 https://github.com/nginx-proxy/nginx-proxy 配合使用效果更佳。

使用 nginx-proxy 可暴露多个主机名，如下所示：

yaml
version: '2'

services:
  nginx-proxy:
    image: nginx-proxy/nginx-proxy
    ports:
      - 80:80
    volumes:
      - /var/run/docker.sock:/tmp/docker.sock:ro

  example:
    image: example
    environment:
      - VIRTUAL_HOST=example.com,www.example.com

使用 adamkdean/redirect 可确保始终使用 www.example.com：

yaml
version: '2'

services:
  nginx-proxy:
    image: nginx-proxy/nginx-proxy
    ports:
      - 80:80
    volumes:
      - /var/run/docker.sock:/tmp/docker.sock:ro

  redirect:
    image: adamkdean/redirect
    environment:
      - VIRTUAL_HOST=example.com
      - REDIRECT_LOCATION="http://www.example.com"
      - REDIRECT_STATUS_CODE=301
      - PRESERVE_URL=true

  example:
    image: example
    environment:
      - VIRTUAL_HOST=www.example.com

配置

单主机模式

• REDIRECT_LOCATION：需设置为重定向目标URI。
• REDIRECT_STATUS_CODE：默认307，可设置为：
  • 301（永久移动）
  • 302（临时移动）
  • 303（查看其他位置）
  • 307（临时重定向）
• PRESERVE_URL：设为 true 可保留URL。设为 false 时，请求将重定向到目标位置（如 https://example.com/posts/24 重定向到 https://www.example.com/）；设为 true 时，将重定向到 https://www.example.com/posts/24 等。

多主机模式

• HOSTS_FILE_PATH：默认 /etc/redirect/hosts.json，可通过环境变量覆盖（见上文）。