neilpang/letsproxy

neilpang/letsproxy 镜像文档

概述

neilpang/letsproxy 是一个集成 Nginx 的反向代理 Docker 镜像，结合 Let's Encrypt 证书自动获取与管理功能，旨在简化 Docker 环境中服务的反向代理和 HTTPS 部署流程。通过挂载 Docker 守护进程套接字（docker.sock），镜像可自动识别和配置 Docker 容器服务，实现 SSL 证书的自动申请、续期及反向代理规则的动态配置。

核心功能与特性

• 集成 Nginx 反向代理：支持 HTTP/HTTPS 反向代理，灵活配置后端服务路由。
• Let's Encrypt 证书自动管理：自动申请、续期 SSL/TLS 证书，无需手动操作。
• Docker 环境深度集成：通过挂载 /var/run/docker.sock，自动发现和配置 Docker 容器服务。
• 多目录配置支持：支持挂载 Nginx 主配置（conf.d）、虚拟主机配置（vhost.d）、流配置（stream.d）等，满足复杂场景需求。
• 灵活的网络模式：推荐使用 --net=host 网络模式，适用于代理主机上所有 Docker 项目及服务。

使用场景

• Docker 环境下多服务的统一入口反向代理。
• 需要快速部署 HTTPS 的 Web 服务（如博客、API 服务、静态网站等）。
• 简化 SSL 证书申请与续期流程，避免手动管理证书的复杂性。
• 开发/测试环境中快速搭建带 HTTPS 的代理服务。

使用方法

1. 运行 Nginx 反向代理

基本运行命令（不使用 host 网络）

sh
docker run  \
-p 80:80 \
-p 443:443 \
-it -d --rm  \
-v /var/run/docker.sock:/tmp/docker.sock:ro  \
-v $(pwd)/proxy/certs:/etc/nginx/certs \
-v $(pwd)/proxy/acme:/acmecerts \
-v $(pwd)/proxy/conf.d:/etc/nginx/conf.d \
-v $(pwd)/vhost.d:/etc/nginx/vhost.d \
-v $(pwd)/stream.d:/etc/nginx/stream.d \
-v $(pwd)/dhparam:/etc/nginx/dhparam \
--name proxy \
neilpang/letsproxy

推荐运行命令（使用 host 网络）

sh
docker run  \
-it -d --rm  \
-v /var/run/docker.sock:/tmp/docker.sock:ro  \
-v $(pwd)/proxy/certs:/etc/nginx/certs \
-v $(pwd)/proxy/acme:/acmecerts \
-v $(pwd)/proxy/conf.d:/etc/nginx/conf.d \
-v $(pwd)/vhost.d:/etc/nginx/vhost.d \
-v $(pwd)/stream.d:/etc/nginx/stream.d \
-v $(pwd)/dhparam:/etc/nginx/dhparam \
--name proxy \
--net=host \
neilpang/letsproxy

说明：

• --net=host 推荐用于 Docker Compose 项目，因每个项目默认使用独立网络，host 网络可代理主机上所有 Docker 服务。
• 挂载卷用途：
  • /var/run/docker.sock:ro：Docker 守护进程套接字，用于服务自动发现
  • /etc/nginx/certs：存放 SSL 证书
  • /acmecerts：Let's Encrypt ACME 客户端数据
  • /etc/nginx/conf.d：Nginx 主配置目录
  • 其他目录分别对应虚拟主机、流配置及 Diffie-Hellman 参数存储

2. Docker Compose 配置

yaml
version: '2'

services:
  letsproxy:
    image: neilpang/letsproxy
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - /var/run/docker.sock:/tmp/docker.sock:ro
      - ./proxy/certs:/etc/nginx/certs
      - ./proxy/acme:/acmecerts
      - ./proxy/conf.d:/etc/nginx/conf.d
      - ./proxy/vhost.d:/etc/nginx/vhost.d 
      - ./proxy/stream.d:/etc/nginx/stream.d 
      - ./proxy/dhparam:/etc/nginx/dhparam 
    network_mode: "host"

3. 运行内部 Web 服务器（被代理服务）

启动需代理的内部服务时，通过环境变量配置域名及证书自动申请：

sh
docker run -itd --rm \
-e VIRTUAL_HOST=foo.bar.com \
-e ENABLE_ACME=true \
httpd

说明：VIRTUAL_HOST 指定服务域名，ENABLE_ACME=true 启用 Let's Encrypt 证书自动申请，letsproxy 会自动配置反向代理及 SSL。

配置说明

环境变量（内部服务容器）

挂载卷说明