icgood/proxy-protocol

icgood/proxy-protocol (已迁移)

镜像概述

重要提示：此 Docker 镜像（icgood/proxy-protocol）已停止在 Docker Hub 更新，并全面迁移至 GitHub Container Registry (GHCR)。 请将所有引用和拉取命令更新为新的镜像地址：https://github.com/icgood/proxy-protocol/pkgs/container/proxy-protocol%E3%80%82

该镜像主要用于提供和测试 PROXY protocol（代理协议）支持。PROXY protocol 允许代理服务器（如 HAProxy、Nginx、AWS ELB 等）在将连接转发到后端服务器时，安全、高效地传递原始客户端的 IP 地址和端口信息。

核心功能与特性

• PROXY Protocol 支持：实现并支持 PROXY protocol v1 和 v2，用于透传真实的客户端网络层信息，解决多层代理导致的源 IP 丢失问题。
• 平滑迁移至 GHCR：镜像已迁移至 GitHub Container Registry，提供更稳定的拉取体验，并与 GitHub 源代码仓库深度集成。
• 轻量级与高性能：专注于协议解析与网络转发，资源占用低，适合作为边车（Sidecar）或独立网络组件部署。

使用场景和适用范围

• 获取真实客户端 IP：在多层代理架构（如 负载均衡器 -> 反向代理 -> 应用服务器）中，确保后端应用能够准确获取真实的客户端 IP。
• 协议测试与调试：用于测试和验证后端服务（如 Web 服务器、数据库）是否正确解析和处理 PROXY protocol 头部数据。
• 云原生环境适配：在 Kubernetes 等云原生环境中，配合 Ingress Controller 或 Service Mesh 使用，保障网络溯源能力。

详细的使用方法和配置说明

1. 更新镜像拉取地址

请停止使用旧的 Docker Hub 地址，改用以下命令从 GHCR 拉取最新镜像：

bash
docker pull ghcr.io/icgood/proxy-protocol:latest

2. Docker 部署示例

以下是一个基本的运行示例，启动一个支持 PROXY protocol 的服务（假设监听 8080 端口）：

bash
docker run -d \
  --name proxy-protocol-service \
  -p 8080:8080 \
  --restart unless-stopped \
  ghcr.io/icgood/proxy-protocol:latest

3. Docker Compose 配置示例

在您的 docker-compose.yml 文件中，请务必更新 image 字段为新的 GHCR 地址：

yaml
version: '3.8'

services:
  proxy:
    image: ghcr.io/icgood/proxy-protocol:latest
    container_name: proxy-protocol-service
    ports:
      - "8080:8080"
    restart: unless-stopped
    # 可根据具体需求添加环境变量或配置文件挂载
    # environment:
    #   - PROXY_PROTOCOL_VERSION=v2

相关链接

• 新镜像地址 (GHCR): https://github.com/icgood/proxy-protocol/pkgs/container/proxy-protocol
• GitHub 源代码仓库: https://github.com/icgood/proxy-protocol