【转载】acme.sh使用说明

文章目录

前言

acme.sh 实现了acme协议, 可以从 letsencrypt 生成免费的证书。由于acme.sh的更新,本文对原文进行了一些补充。
主要步骤:

  1. 安装 acme.sh
  2. 生成证书
  3. copy 证书到 nginx/apache 或者其他服务
  4. 更新证书
  5. 更新 acme.sh
  6. 出错怎么办, 如何调试

下面详细介绍。

安装 acme.sh

安装很简单, 一个命令:

curl  https://get.acme.sh | sh

可能会提示:It is recommended to install socat first.
如果你不使用standalone模式,那么可以忽略它,如果你想使用的话,则

#centos
yum install socat -y
#debian/ubuntu
apt install socat -y

普通用户和 root 用户都可以安装使用. 安装过程进行了以下几步:
1.把 acme.sh 安装到你的 home 目录下:

~/.acme.sh/

并创建 一个 bash 的 alias, 方便你的使用:acme.sh=~/.acme.sh/acme.sh

alias acme.sh=~/.acme.sh/acme.sh

这样设置的alias重启之后就会失效,如果想要长久使用则需要把上面的指令加入/etc/bashrc或者/etc/bash.bashrc
2.自动为你创建 cronjob, 每天 0:00 点自动检测所有的证书, 如果快过期了, 需要更新, 则会自动更新证书.
更高级的安装选项请参考: https://github.com/Neilpang/acme.sh/wiki/How-to-install
安装过程不会污染已有的系统任何功能和文件, 所有的修改都限制在安装目录中:~/.acme.sh/

生成证书

acme.sh 实现了 acme 协议支持的所有验证协议. 一般有两种方式验证:httpdns验证。

http方式

1. http 方式需要在你的网站根目录下放置一个文件, 来验证你的域名所有权,完成验证. 然后就可以生成证书了.

acme.sh  --issue  -d mydomain.com -d www.mydomain.com  --webroot  /home/wwwroot/mydomain.com/

只需要指定域名, 并指定域名所在的网站根目录. acme.sh 会全自动的生成验证文件, 并放到网站的根目录, 然后自动完成验证. 最后会聪明的删除验证文件. 整个过程没有任何副作用。

如果你用的apache服务器,acme.sh还可以智能的从apache的配置中自动完成验证, 你不需要指定网站根目录,当然使用这种方式你需要在apache中配置你的虚拟主机,apache中首先要有关于你的域名的配置:

acme.sh --issue  -d mydomain.com   --apache

如果你用的nginx服务器,或者反代,acme.sh还可以智能的从nginx的配置中自动完成验证,你不需要指定网站根目录,当然同样你也需要首先在nginx中配置你的虚拟主机,nginx中首先要有关于你的域名的配置:

acme.sh --issue  -d mydomain.com   --nginx

注意, 无论是apache还是nginx模式,acme.sh在完成验证之后,会恢复到之前的状态,都不会私自更改你本身的配置。好处是你不用担心配置被搞坏,也有一个缺点,你需要自己配置ssl的配置, 否则只能成功生成证书,你的网站还是无法访问https。但是为了安全,你还是自己手动改配置吧。
如果你还没有运行任何 web 服务, 80 端口是空闲的, 那么 acme.sh 还能假装自己是一个webserver, 临时听在80 端口, 完成验证,这种办法需要socat:

acme.sh  --issue -d mydomain.com   --standalone

更高级的用法请参考: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert

dns方式

用法参考:https://github.com/Neilpang/acme.sh/wiki/dns-manual-mode
dns 方式, 在域名上添加一条 txt 解析记录, 验证域名所有权。
这种方式的好处是, 你不需要任何服务器, 不需要任何公网 ip, 只需要 dns 的解析记录即可完成验证. 坏处是,如果不同时配置 Automatic DNS API(可以参考本博客文章:),使用这种方式 acme.sh 将无法自动更新证书,每次都需要手动再次重新解析验证域名所有权。

  1. acme.sh --issue -d example.com --dns \
     --yes-I-know-dns-manual-mode-enough-go-ahead-please
    
  2. 然后, acme.sh 会生成相应的解析记录显示出来, 你只需要在你的域名管理面板中添加这条 txt 记录即可。
    等待解析完成之后, 重新生成证书:

  3. acme.sh --renew -d example.com \
      --yes-I-know-dns-manual-mode-enough-go-ahead-please
    

    注意第二次这里用的是--renew

dns 方式的真正强大之处在于可以使用域名解析商提供的 api 自动添加 txt 记录完成验证.
acme.sh 目前支持 cloudflare, dnspod, cloudxns, godaddy 以及 ovh 等数十种解析商的自动集成.
以 dnspod 为例, 你需要先登录到 dnspod 账号, 生成你的 api id 和 api key, 都是免费的. 然后:

export DP_Id="1234"
export DP_Key="sADDsdasdgdsf"
acme.sh   --issue   --dns dns_dp   -d aa.com  -d www.aa.com

证书就会自动生成了. 这里给出的 api id 和 api key 会被自动记录下来, 将来你在使用 dnspod api 的时候, 就不需要再次指定了. 直接生成就好了:

acme.sh  --issue   -d  mydomain2.com   --dns  dns_dp

更详细的 api 用法: https://github.com/Neilpang/acme.sh/blob/master/dnsapi/README.md

copy/安装证书

前面证书生成以后, 接下来需要把证书 copy 到真正需要用它的地方。
注意, 默认生成的证书都放在安装目录下: ~/.acme.sh/, 请不要直接使用此目录下的文件, 例如: 不要直接让 nginx/apache 的配置文件使用这下面的文件. 这里面的文件都是内部使用, 而且目录结构可能会变化。
正确的使用方法是使用--installcert命令,并指定目标位置, 然后证书文件会被copy到相应的位置, 例如:

acme.sh  --installcert  -d  .com   \
        --key-file   /etc/nginx/ssl/.key \
        --fullchain-file /etc/nginx/ssl/fullchain.cer \
        --reloadcmd  "service nginx force-reload"

(一个小提醒, 这里用的是service nginx force-reload, 不是service nginx reload, 据测试,reload并不会重新加载证书, 所以用的force-reload)。
Nginx 的配置ssl_certificate使用/etc/nginx/ssl/fullchain.cer,而非/etc/nginx/ssl/.cer,否则 SSL Labs 的测试会报Chain issues Incomplete错误。
--installcert命令可以携带很多参数, 来指定目标文件. 并且可以指定 reloadcmd, 当证书更新以后, reloadcmd会被自动调用,让服务器生效。
详细参数请参考: https://github.com/Neilpang/acme.sh#3-install-the-issued-cert-to-apachenginx-etc
值得注意的是, 这里指定的所有参数都会被自动记录下来, 并在将来证书自动更新以后, 被再次自动调用。

更新证书

目前证书在 60 天以后会自动更新, 你无需任何操作. 今后有可能会缩短这个时间, 不过都是自动的, 你不用关心。
如果你需要更新,使用--renew即可。

更新 acme.sh

目前由于 acme 协议和 letsencrypt CA 都在频繁的更新, 因此 acme.sh 也经常更新以保持同步。
升级 acme.sh 到最新版 :

acme.sh --upgrade

如果你不想手动升级, 可以开启自动升级:

acme.sh  --upgrade  --auto-upgrade

之后, acme.sh 就会自动保持更新了。
你也可以随时关闭自动更新:

acme.sh --upgrade  --auto-upgrade  0

出错怎么办:

如果出错, 请添加 debug log:

acme.sh  --issue  .....  --debug 

或者:

acme.sh  --issue  .....  --debug  2

请参考:https://github.com/Neilpang/acme.sh/wiki/How-to-debug-acme.sh
最后, 本文并非完全的使用说明, 还有很多高级的功能, 更高级的用法请参看其他 wiki 页面。
https://github.com/Neilpang/acme.sh/wiki

Buy me a beer, Donate to acme.sh if it saves your time. Your donation makes acme.sh better: https://donate.acme.sh/

如果 acme.sh 帮你节省了时间,请考虑赏我一杯咖啡, 捐助:https://donate.acme.sh/ 你的支持将会使得 acme.sh 越来越好. 感谢。

原文链接:https://github.com/Neilpang/acme.sh/wiki/%E8%AF%B4%E6%98%8E

发表评论