valian/docker-nginx-auto-ssl

docker-nginx-auto-ssl

为网站添加SSL证书的最简单解决方案

!build !build

镜像概述和主要用途

该Docker镜像基于OpenResty和lua-resty-auto-ssl，可自动生成和续期Let's Encrypt SSL证书。内置合理的SSL设置、HTTP/2和WebSocket支持，开箱即用。支持通过环境变量指定允许的域名和简单代理，也可轻松覆盖nginx.conf以满足自定义需求。镜像状态：已用于生产环境，未来可能添加向后兼容的变更。

核心功能和特性

• 自动SSL证书管理：使用Let's Encrypt自动生成和续期SSL证书
• 丰富协议支持：内置HTTP/2和WebSocket支持
• 灵活配置：通过环境变量快速配置域名和代理，支持多站点代理
• 可扩展性：支持自定义Nginx配置、服务器模板和存储适配器
• 生产就绪：合理的SSL默认设置，已在生产环境验证

使用场景和适用范围

• 需要为网站或Web应用快速添加SSL证书的场景
• 多域名或子域名的代理服务
• 希望简化SSL证书管理流程的个人或企业用户
• 负载均衡环境下的证书共享（通过Redis存储适配器）

使用方法

快速启动

以下命令可快速为博客或应用生成并自动续期SSL证书：

Bash
# 替换为实际值
export DOMAIN=yourdomain.com
export APP_ADDRESS=localhost:8080

# 安装Docker后执行以下命令
docker run -d \
  --name nginx-auto-ssl \
  --restart on-failure \
  --network host \
  -e ALLOWED_DOMAINS="$DOMAIN" \
  -e SITES="$DOMAIN=$APP_ADDRESS" \
  -v ssl-data:/etc/resty-auto-ssl \
  valian/docker-nginx-auto-ssl

# 查看容器日志以确认是否正常运行
docker logs nginx-auto-ssl

Docker Compose示例

yaml
# docker-compose.yml
version: '2'
services:
  nginx:
    image: valian/docker-nginx-auto-ssl
    restart: on-failure
    ports:
      - 80:80
      - 443:443
    volumes:
      - ssl_data:/etc/resty-auto-ssl
    environment:
      ALLOWED_DOMAINS: 'yourdomain.com'
      SITES: 'yourdomain.com=myapp:80'
  
  # 你的应用，监听SITES环境变量中指定的端口
  myapp:
    image: nginx

volumes:
  ssl_data:

启动命令：

Bash
docker-compose up -d

注意：上述两种方式均要求yourdomain.com的请求能够到达部署的Nginx（即服务器已正确配置DNS记录）。

多站点代理示例

Bash
docker run -d \
  --name nginx-auto-ssl \
  --restart on-failure \
  -p 80:80 \
  -p 443:443 \
  -e ALLOWED_DOMAINS=example.com \
  -e SITES='example.com=localhost:5432;*.example.com=localhost:8080' \
  valian/docker-nginx-auto-ssl

配置选项

自定义配置

从/etc/nginx/conf.d/*.conf加载配置

额外的服务器块会自动从/etc/nginx/conf.d/*.conf加载。若需提供自定义配置，可使用卷挂载或创建自定义镜像。

示例服务器配置（例如命名为server.conf）：

nginx
server {
  listen 443 ssl default_server;
  
  # 务必包含此行！
  include resty-server-https.conf;

  location / {
    proxy_pass http://app;
  }
  
  location /api {
    proxy_pass http://api;
  }
}

卷挂载方式：

Bash
# 将$PWD替换为包含自定义配置的目录
docker run -d \
  --name nginx-auto-ssl \
  --restart on-failure \
  -p 80:80 \
  -p 443:443 \
  -v $PWD:/etc/nginx/conf.d \
  valian/docker-nginx-auto-ssl

自定义镜像方式：

Dockerfile
FROM valian/docker-nginx-auto-ssl

# 将.替换为包含自定义配置的目录
COPY . /etc/nginx/conf.d

构建并运行：

Bash
docker build -t docker-nginx-auto-ssl .
docker run [YOUR_OPTIONS] docker-nginx-auto-ssl

使用自定义SITES模板

需通过卷挂载或自定义镜像覆盖/usr/local/openresty/nginx/conf/server-proxy.conf。模板支持$SERVER_NAME和$SERVER_ENDPOINT变量。

示例模板：

nginx
server {
  listen 443 ssl;
  server_name $SERVER_NAME;

  include resty-server-https.conf;

  location / {
    proxy_pass http://$SERVER_ENDPOINT;
  }
}

自定义nginx.conf

若其他自定义选项无法满足需求，可提供自己的nginx.conf。

示例Dockerfile：

Dockerfile
FROM valian/docker-nginx-auto-ssl

COPY nginx.conf /usr/local/openresty/nginx/conf/

最小可用nginx.conf：

nginx
events {
  worker_connections 1024;
}

http {
  
  # 必须包含
  include resty-http.conf;

  server {
    listen 443 ssl;
    
    # 必须包含
    include resty-server-https.conf;
    
    # 在此添加自定义location
  }

  server {
    listen 80 default_server;
    
    # 必须包含
    include resty-server-http.conf;
  }
}

支持SITES和conf.d包含的最小nginx.conf：

nginx
events {
  worker_connections 1024;
}

http {

  include resty-http.conf;

  server {
    listen 80 default_server;
    include resty-server-http.conf;
  }
  
  # 可在此处或conf.d中插入自定义块
  
  include /etc/nginx/conf.d/*.conf;
}

构建并运行：

Bash
docker build -t docker-nginx-auto-ssl .
docker run [YOUR_OPTIONS] docker-nginx-auto-ssl

更新日志

• 2019-11-11 - 添加gzip支持，移除TLS 1.0和1.1 #33
• 2019-04-18 - 添加WebSocket支持 #22
• 2017-05-29 - 修复容器重启后重复重定向位置的问题 #2
• 2017-12-19 - 支持$SITES变量
• 2017-12-02 - 默认移除HSTS
• 2017-11-25 - 初始发布

许可证

MIT