yalespinup/nginxproxy

nginxproxy 镜像文档

镜像概述

nginxproxy是一个基于nginx的SSL代理镜像，设计用于作为sidecar代理，为前置应用提供加密端点。该镜像在启动时会自动生成自签名SSL证书，并监听指定端口，将接收到的连接代理到配置的后端服务。

注意：这是一个示例实现，主要展示如何构建sidecar代理以提供加密端点，可能需要根据具体使用场景进行自定义调整。

核心功能与特性

• 自动生成自签名证书：启动时自动生成SSL证书，支持自定义证书有效期、加密算法及大小、证书主题等参数
• 灵活的后端代理：默认将连接代理至http://127.0.0.1:8080，支持通过环境变量配置任意后端服务URL
• 可配置监听端口：默认监听8443端口，可通过环境变量自定义代理服务的监听端口
• 轻量级集成：适合作为sidecar容器与主应用配合使用，快速为应用添加HTTPS加密能力

使用场景与适用范围

• 需要为不直接支持HTTPS的应用快速添加加密端点的场景
• 作为sidecar容器与主应用容器配合使用，提供额外的加密代理层
• 本地开发、测试环境中临时启用HTTPS访问能力
• 微服务架构中为内部服务提供简单的加密通信能力

使用方法与配置说明

环境变量配置

nginxproxy镜像支持通过以下环境变量进行自定义配置：

Docker 部署示例

基本使用（默认配置）

bash
docker run -d --name nginx-proxy docker.xuanyuan.run/nginxproxy

此命令将启动nginxproxy容器，使用默认配置：生成有效期10年（3650天）、2048位RSA加密、主题为/CN=localhost的证书，监听8443端口，将连接代理至http://127.0.0.1:8080。

自定义后端服务和监听端口

bash
docker run -d \
  -e BACKEND_URL=http://my-app:3000 \
  -e LISTEN_PORT=443 \
  -p 443:443 \
  --name nginx-proxy \
  docker.xuanyuan.run/nginxproxy

此命令将：

• 配置后端服务为http://my-app:3000
• 设置监听端口为443
• 将容器的443端口映射到主机的443端口

自定义证书参数

bash
docker run -d \
  -e CERT_EXPIRE=730 \
  -e CERT_SIZE=rsa:4096 \
  -e CERT_SUBJECT=/CN=myapp.example.com \
  -e BACKEND_URL=http://app:8080 \
  -e LISTEN_PORT=8443 \
  -p 8443:8443 \
  --name nginx-proxy \
  docker.xuanyuan.run/nginxproxy

此命令将生成有效期2年（730天）、4096位RSA加密、主题为/CN=myapp.example.com的证书，并代理至http://app:8080。

Docker Compose 配置示例

yaml
version: '3'

services:
  proxy:
    image: docker.xuanyuan.run/nginxproxy
    environment:
      - BACKEND_URL=http://app:8080
      - LISTEN_PORT=8443
      - CERT_EXPIRE=365
      - CERT_SUBJECT=/CN=my-app.local
    ports:
      - "8443:8443"
    depends_on:
      - app

  app:
    image: docker.xuanyuan.run/my-app-image
    # 主应用容器配置

此配置将nginxproxy作为sidecar容器与app服务配合使用，为app服务提供HTTPS代理能力。

作者信息

E Camden Fisher <***>

许可证

GNU Affero General Public License v3.0 (GNU AGPLv3)
Copyright (c) 2020 Yale University