Lua-Resty-Auto-SSL 安装与使用指南

1. 项目目录结构及介绍

Lua-Resty-Auto-SSL 是一个用于自动获取和续签 Let's Encrypt SSL/TLS 证书的 Lua 模块。以下是项目的基本目录结构：

lua-resty-auto-ssl
├── CHANGELOG.md        # 更新日志
├── CONTRIBUTING.md     # 贡献指南
├── Dockerfile          # Docker 镜像构建文件
├── LICENSE              # 许可证文件
├── README.md            # 项目简介
├── bin                  # 启动脚本
│   └── start.sh         # 服务启动脚本
├── conf                 # 示例配置文件
│   ├── config.yaml.example    # 样例配置文件
│   └── lets_encrypt_terms_of_service.txt # Let's Encrypt 服务条款
├── lib                  # 主要的 Lua 源代码
│   └── auto_ssl.lua       # 自动 SSL 模块
└── tests                # 单元测试

• bin: 包含用于启动服务的脚本。
• conf: 提供配置文件模板以及 Let's Encrypt 的服务条款。
• lib: 存放 Lua 模块的核心代码。

2. 项目启动文件介绍

在项目根目录下的 bin/start.sh 是一个简单的 shell 脚本，用于启动 Lua-Resty-Auto-SSL 服务。该脚本主要执行以下步骤：

• 设置环境变量（例如 $RESTY_AUTO_SSL_SHARDED_CACHE 和 $RESTY_AUTO_SSL_DIR）。
• 使用 openresty 命令启动 Nginx 并加载配置文件。
• 在运行时确保配置文件指向正确的目录并应用了必要的配置。

你可以修改此脚本来适应你的具体环境，并添加任何必要的自定义设置。

3. 项目配置文件介绍

配置文件位于 conf/config.yaml.example，这是项目的一个示例配置文件。以下是其中的关键参数说明：

# 项目主目录，存放证书等相关数据
dir: /path/to/your/custom/data/dir

# 是否开启调试模式
debug: false

# Let's Encrypt 的客户端 ID 和密钥
lets_encrypt_client_id: your LetsEncrypt client id
lets_encrypt_client_email: [e-mail]

# Nginx 连接超时时间（单位：秒）
nginx_timeout: 5

# 验证主机名的 DNS A 记录
dns_resolver:
  - 8.8.8.8
  - 8.8.4.4

# 缓存策略，可以是 "shared_memory" 或 "local_directory"
sharded_cache: shared_memory

# 如果使用 local_directory 作为缓存策略，设置本地缓存目录
cache_dir: /path/to/cache/directory

# 策略设置，决定何时重试 SSL 证书请求
retry_strategy:
  backoff_factor: 2
  max_jitter: 0.5
  max_retries: 3

在实际部署时，你需要将 config.yaml.example 复制到自己的配置目录下，并根据你的环境替换相关值。特别是 lets_encrypt_client_id 和 lets_encrypt_client_email，你需在 Let's Encrypt 注册并获取这些信息。

完成上述步骤后，你就可以通过修改 start.sh 中的配置路径来启动服务，享用自动获取和管理 Let's Encrypt SSL 证书的便利了。记得在启动之前，确保所有依赖项都已安装并且满足项目要求。