跳转到主要内容

从letsencrypt.org请求SSL证书

项目描述

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

编写此模块是为了让您的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。可以使用通配符证书来避免该限制。

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

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

使用

该模块设置了一个cronjob,它会自动请求和续订证书。

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

第一次运行后,您将在$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

贡献者

其他鸣谢

ACME实现

图标

维护者

本模块由OCA维护。

Odoo Community Association

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

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

欢迎您贡献力量。了解更多信息请访问https://odoo-community.org/page/Contribute

项目详情


下载文件

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

源代码分发

此版本未提供源代码分发文件。请参阅生成分发存档的教程。

构建分发

odoo10_addon_letsencrypt-10.0.2.0.1-py2-none-any.whl (150.1 kB 查看哈希值)

上传时间 Python 2

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面