Skip to content

Commit

Permalink
Add cert functions describtion
Browse files Browse the repository at this point in the history
  • Loading branch information
crackair committed Apr 6, 2021
1 parent d7d363a commit 6c9066e
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@
* [限速功能说明](functions/speedlimit.md)
* [自定义DNS说明](functions/dns.md)
* [审计功能说明](functions/rule.md)
* [自动申请证书说明](functions/cert.md)

26 changes: 26 additions & 0 deletions functions/cert.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 自动申请证书说明

XrayR 支持多种自动申请证书配置。申请到的证书将会放在XrayR软件运行目录的`.lego`文件夹下。

以下是自动申请证书的相关配置文件说明。

``` yaml
CertConfig:
CertMode: dns # Option about how to get certificate: none, file, http, dns. Choose "none" will forcedly disable the tls config.
CertDomain: "node2.test.com" # Domain to cert
CertFile: ./cert/node2.test.com.cert # Provided if the CertMode is file
KeyFile: ./cert/node2.test.com.key
Provider: alidns # DNS cert provider, Get the full support list here: https://go-acme.github.io/lego/dns/
Email: [email protected]
DNSEnv: # DNS ENV option used by DNS provider
ALICLOUD_ACCESS_KEY: aaa
ALICLOUD_SECRET_KEY: bbb
```
| 参数 | 选项 | 说明 |
| ------------ | --------------------------------------- | ---------------------------- |
| `CertMode` | `none`,`file`,`http`,`dns`| 获取证书的方式。`file`:手动提供,并制定路径。`http`:通过http申请,需要80端口。`dns`:使用dns模式申请,需要制定相关dns服务商配置。`none`:强制关闭tls设置,交由nginx或者caddy处理。|
|`CertDomain`|无|申请证书域名|
|`CertFile`|无|手动指定的证书路径|
|`KeyFile`|无|手动指定的私钥路径|
|`Provider`|无|dns提供商,所有支持的dns提供商请在此获取:https://go-acme.github.io/lego/dns/
|`DNSEnv`|无|采用DNS申请证书需要的环境变量,请参考上文链接内,自己的dns提供商所需要的参数,填写于此。请注意一行一个,填写时需符合yaml文件格式。|

0 comments on commit 6c9066e

Please sign in to comment.