SiteEncrypt：通过Let's Encrypt为Elixir驱动的站点集成证书管理教程

SiteEncrypt：通过Let's Encrypt为Elixir驱动的站点集成证书管理教程

site_encryptIntegrated certification via Let's encrypt for Elixir-powered sites 项目地址:https://gitcode.com/gh_mirrors/si/site_encrypt

一、项目目录结构及介绍

SiteEncrypt 是一个专为 Elixir 项目设计的，旨在简化 Let's Encrypt 证书获取和管理过程的开源库。虽然具体的目录结构在不同版本间可能会有微小变动，以下提供一般性的概述：

• lib: 包含核心库代码，如 site_encrypt.ex 文件，是处理证书申请、更新等逻辑的核心。
• mix.exs: 项目配置文件，定义了依赖关系、版本以及项目的元数据。
• config: 存放配置文件的地方，其中 config.config 或相关环境特定的配置文件（如 config/prod.exs）将包含与 SiteEncrypt 相关的设置。
• test: 单元测试文件夹，用于确保项目功能的健壮性。
• README.md: 提供快速入门指南、安装步骤和基本使用说明。

二、项目的启动文件介绍

尽管SiteEncrypt本身并不直接控制项目的启动流程，它需要被正确地集成到您的Phoenix应用中。通常，您会在项目的主Endpoint模块（比如 MyApp.Web.Endpoint) 中加入对SiteEncrypt的支持。这可能涉及替换或添加如下的代码行：

# 在你的endpoint.ex中
use MyApp.SiteEncrypt.Phoenix.Endpoint, otp_app: :my_app

这里假设您已创建了一个适应SiteEncrypt的端点扩展。启动时，SiteEncrypt的相关配置会被读取并准备自动执行证书管理任务，具体行为取决于配置的模式(:mode)和其他配置选项。

三、项目的配置文件介绍

配置主要发生在项目的配置文件中，通常是config/prod.exs或适用于相应运行环境的文件。示例配置可能包括：

config :my_app, MyApp.SiteEncrypt.Phoenix.Endpoint,
  otp_app: :my_app,
  certification: [
    client: :native,
    domains: ["mysite.com", "www.mysite.com"],
    emails: ["contact@abc.org", "another_contact@abc.org"],
    # 设置临时存储路径，生产环境中应配置绝对路径以防部署覆盖
    # 可以通过环境变量SITE_ENCRYPT_DB设置实际生产路径
  ]

• client: 指定使用的客户端类型，:native适合开发环境，但生产中考虑稳定性可能会选择其他方式，如通过Certbot (:certbot)。
• domains: 列出需要申请SSL证书的域名。
• emails: 用于验证域名所有权的电子邮件地址。
• 配置模式（未直接展示，但在使用中重要）可以是:auto, :manual, 或 :trial来控制证书认证的自动化程度。

确保这些配置符合您的需求，并且在生产环境前进行充分测试。记住，在手动模式下，首次部署后可能需要通过iex会话执行特定命令来完成认证过程。

---

本教程提供了快速概览，实际操作时请参考项目最新的README.md和官方文档，因为具体的实施细节可能会随着项目版本迭代而更新。

site_encryptIntegrated certification via Let's encrypt for Elixir-powered sites 项目地址:https://gitcode.com/gh_mirrors/si/site_encrypt