跳转到主要内容

从letsencrypt.org请求SSL证书

项目描述

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runboat

此模块是为了使您的Odoo安装自动从https://letsencrypt.openssl.ac.cn请求SSL证书而编写的。

目录

安装

安装后,此模块会自动在$data_dir/letsencrypt/account.key为您在letsencrypt.org的账户生成一个私钥。如果您想或需要使用自己的账户密钥,请替换文件。

为了使证书请求正常工作,您的网站需要通过纯HTTP访问,如果您的客户端被强制使用SSL版本,请参阅下面的配置示例。

安装后,触发计划任务“更新letsencrypt证书”,并查看日志中的消息。

配置

此插件请求配置参数web.base.url中命名的域的证书 - 如果返回值为localhost或类似,则该模块不会请求任何内容。

进一步的说明性设置在设置 -> 通用设置中。在那里您可以添加更多的域到CSR,添加一个自定义脚本以更新您的DNS,并添加一个将用于重新加载您的Web服务器的脚本(如果需要)。证书中可以添加的域名数量限制为100。可以使用通配符证书来避免此限制。

请注意,所有这些域名必须在端口80上通过HTTP公开可达,并且它们必须有一个指向您Odoo实例的 $datadir/letsencrypt/acme-challenge.well-known/acme-challenge 条目。

由于DNS更改可能需要一段时间才能传播,当响应DNS挑战并尝试检查我们的响应时,可能会失败(并且可能确实会失败)。解决方法在 https://tools.ietf.org/html/rfc8555#section-8.2 中有文档说明,基本上是一个 Retry-After 报头,我们可以使用它来指示服务器重试挑战。在编写这些行的时候,Boulder还没有实现这个功能。这促使我们使用 letsencrypt.backoff 配置参数,这是该模块尝试轮询服务器以重试验证我们对挑战的答案的时间(分钟),具体来说,它是 poll_and_finalizedeadline 参数。

使用

该模块设置了一个cron作业,用于自动请求和续订证书。

证书在到期前一个月进行续订。然后,每天尝试续订,直到成功。

第一次运行后,您将在 $datadir/letsencrypt 中找到一个名为 domain.crt 的文件,配置您的SSL代理使用此文件作为证书。

详细配置

如果您想在CSR上使用多个域名,则必须从设置 -> 通用设置中进行配置。如果您在其中的任何域名中使用通配符,则letsencrypt将返回一个DNS挑战。为了回答该挑战,您需要 提供脚本(如通用设置中所见)或安装一个提供对您的DNS提供商支持的模块。在该模块中,您需要在letsencrypt模型中创建一个名为 _respond_challenge_dns_$DNS_PROVIDER 的函数,其中 $DNS_PROVIDER 是您的提供商的名称,可以是长度大于零的任何字符串,并在设置页面中的dns_provider选择字段中添加您的DNS提供商的名称。

无论如何,如果在设置页面中插入脚本路径,它将在您想要更新多个DNS服务器时运行。

您还可以在设置中设置重新加载命令,以防您需要重新加载您的Web服务器。默认情况下,这是 sudo /usr/sbin/service nginx reload

您还需要一个相应的sudo配置,例如

your_odoo_user ALL = NOPASSWD: /usr/sbin/service nginx reload

此外,如果您强制用户使用https,则对于nginx,您需要类似以下内容

if ($scheme = "http") {
    set $redirect_https 1;
}
if ($request_uri ~ ^/.well-known/acme-challenge/) {
    set $redirect_https 0;
}
if ($redirect_https) {
    rewrite ^   https://$server_name$request_uri? permanent;
}

和以下内容用于apache

RewriteEngine On
RewriteCond %{HTTPS} !=on
RewriteCond %{REQUEST_URI} "!^/.well-known/"
RewriteRule ^/?(.*) https://%{SERVER_NAME}/$1 [R,L]

如果您需要将其他nginx站点重定向到您的Odoo实例,请为您的odoo实例声明一个upstream并执行以下操作

location /.well-known {
    proxy_pass    http://yourodooupstream;
}

如果您使用的是多数据库安装(具有或没有dbfilter选项),其中/web/database/selector返回一个包含多个数据库的列表,则您需要将 letsencrypt 扩展添加到广泛加载的扩展列表中(默认情况下,只有 web 扩展),设置 --load 选项。例如,--load=web,letsencrypt

错误追踪器

错误在 GitHub Issues 上跟踪。如果您的问题已经报告,请在那里检查。如果您是第一个发现它的人,请帮助我们通过提供详细和受欢迎的 反馈

请不要直接联系贡献者以获取支持或技术问题的帮助。

致谢

作者

  • Therp BV

  • Tecnativa

  • Acysos S.L

贡献者

其他致谢

ACME实现

图标

维护者

本模块由OCA维护。

Odoo Community Association

OCA,即Odoo社区协会,是一个非营利组织,其使命是支持Odoo功能的协作开发并推广其广泛应用。

本模块是GitHub上OCA/server-tools项目的组成部分。

欢迎您贡献力量。了解如何贡献,请访问https://odoo-community.org/page/Contribute

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源代码分发

此版本没有可用的源代码分发文件。请参阅生成分发存档的教程。

构建分发

odoo12_addon_letsencrypt-12.0.2.0.1-py3-none-any.whl (168.0 kB 查看哈希)

上传时间 Python 3

由以下机构支持