OpenFreemap 项目环境变量配置指南

背景介绍

OpenFreemap 是一个开源地图项目，在自托管部署过程中需要正确配置环境变量。本文档将详细介绍与 Let's Encrypt 证书相关的环境变量配置要点，帮助开发者避免常见配置错误。

关键环境变量解析

DOMAIN_LE 变量

该变量用于指定需要使用 Let's Encrypt 证书的直接子域名。格式应为通配符形式，例如 *.example.com。这个变量是获取 SSL 证书的基础配置项。

LE_EMAIL 变量

Let's Encrypt 账户的注册邮箱地址，用于证书管理和到期提醒。格式应为有效的电子邮件地址，例如 [e-mail]。

DOMAIN_LEDNS 变量

这是一个特殊用途的变量，用于以下场景：

1. 证书在一台服务器上获取
2. 然后上传到存储桶
3. 最后由 HTTP 主机服务器下载使用

重要提示：对于大多数自托管场景，此变量应保持为空。如果不需要上述特殊流程却设置了此变量，可能会导致证书获取失败。

SKIP_LETSENCRYPT 变量

当设置为 true 时，将跳过 Let's Encrypt 证书获取流程。这个选项适用于以下情况：

• 已经通过其他方式（如 Traefik）管理 SSL 证书
• 在测试环境中不需要 HTTPS
• 使用自签名证书

常见配置错误及解决方案

错误现象

在配置过程中可能会遇到如下错误提示：

Client with the currently selected authenticator does not support any combination of challenges that will satisfy the CA. You may need to use an authenticator plugin that can do challenges over DNS.

解决方案

1. 确认 DOMAIN_LEDNS 变量是否被意外设置，如果不需要特殊流程应保持为空
2. 如果使用外部证书管理，设置 SKIP_LETSENCRYPT=true
3. 检查 DNS 解析是否正常

最佳实践建议

1. 对于标准自托管部署，只需配置 DOMAIN_LE 和 LE_EMAIL 即可
2. 如果使用 Traefik 等反向代理管理证书，建议设置 SKIP_LETSENCRYPT=true 并保持 DOMAIN_LEDNS 为空
3. 测试环境可以先跳过证书获取流程，待基础功能验证通过后再配置 HTTPS
4. 生产环境务必确保 DNS 解析正确配置，避免证书验证失败

验证方法

部署完成后，可以通过以下命令验证服务是否正常运行：

curl -sI https://yourdomain.com/planet | sort
curl -sI https://yourdomain.com/planet/latest_version | sort
curl -sI https://yourdomain.com/planet/latest_version/14/8529/5975.pbf | sort

通过这些测试可以确认地图瓦片服务是否可访问，以及 HTTPS 配置是否正确生效。