Nginx Proxy Automation 项目教程

1. 项目的目录结构及介绍

Nginx Proxy Automation 项目的目录结构如下：

nginx-proxy-automation/
├── bin/
│   ├── fresh-start.sh
│   ├── test.sh
│   └── ...
├── docker-compose.yml
├── .env
├── README.md
└── ...

目录介绍

• bin/: 包含项目的启动脚本和测试脚本。
  • fresh-start.sh: 用于初始化项目的脚本。
  • test.sh: 用于测试代理功能的脚本。
• docker-compose.yml: Docker Compose 配置文件，用于定义和运行多容器应用。
• .env: 环境变量配置文件，包含项目的配置参数。
• README.md: 项目说明文档，包含项目的详细介绍和使用指南。

2. 项目的启动文件介绍

fresh-start.sh

fresh-start.sh 脚本用于初始化项目，其主要功能包括：

• 检查 Docker 和 Docker Compose 是否已安装。
• 创建必要的目录和文件。
• 启动 Nginx 代理容器。

使用方法：

./bin/fresh-start.sh --yes --skip-docker-image-check -e [e-mail]

test.sh

test.sh 脚本用于测试代理功能，其主要功能包括：

• 启动一个测试容器，并设置 VIRTUAL_HOST 环境变量。
• 验证代理是否正常工作。

使用方法：

./bin/test.sh your_domain.com

3. 项目的配置文件介绍

docker-compose.yml

docker-compose.yml 文件定义了项目的多容器应用配置，主要包含以下服务：

• nginx-proxy: Nginx 代理服务，负责处理 HTTP 和 HTTPS 请求。
• nginx-proxy-letsencrypt: Let's Encrypt 证书管理服务，用于自动生成和更新 SSL 证书。

示例配置：

version: '3'
services:
  nginx-proxy:
    image: jwilder/nginx-proxy
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - /var/run/docker.sock:/tmp/docker.sock:ro
      - ./certs:/etc/nginx/certs
    networks:
      - proxy-tier
  nginx-proxy-letsencrypt:
    image: jrcs/letsencrypt-nginx-proxy-companion
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - ./certs:/etc/nginx/certs
    environment:
      - DEFAULT_EMAIL=[e-mail]
    networks:
      - proxy-tier
networks:
  proxy-tier:
    driver: bridge

.env

.env 文件用于设置环境变量，主要包含以下参数：

• DEFAULT_EMAIL: 用于 Let's Encrypt 证书申请的邮箱地址。

示例配置：

DEFAULT_EMAIL=[e-mail]

通过以上配置，可以快速启动和配置 Nginx Proxy Automation 项目，实现自动化的 Nginx 代理和 SSL 证书管理。