removed config example from README, check config.example.yml for complete explaination

This commit is contained in:
yusing 2024-09-27 09:59:36 +08:00
parent f474ae4f75
commit a935f200a3
2 changed files with 6 additions and 42 deletions

View file

@ -107,27 +107,7 @@ Copy [`.vscode/settings.example.json`](.vscode/settings.example.json) to `.vscod
### Config File ### Config File
See [config.example.yml](config.example.yml) for more See [config.example.yml](config.example.yml)
```yaml
# autocert configuration
autocert:
email: # ACME Email
domains: # a list of domains for cert registration
provider: # DNS Challenge provider
options: # provider specific options
- ...
# reverse proxy providers configuration
providers:
include:
- providers.yml
- other_file_1.yml
- ...
docker:
local: $DOCKER_HOST
remote-1: tcp://10.0.2.1:2375
remote-2: ssh://root:1234@10.0.2.2
```
[🔼Back to top](#table-of-content) [🔼Back to top](#table-of-content)

View file

@ -18,6 +18,10 @@
- [重點](#重點) - [重點](#重點)
- [入門指南](#入門指南) - [入門指南](#入門指南)
- [安裝](#安裝) - [安裝](#安裝)
- [命令行參數](#命令行參數)
- [環境變量](#環境變量)
- [VSCode 中使用 JSON Schema](#vscode-中使用-json-schema)
- [配置文件](#配置文件)
- [透過文件配置](#透過文件配置) - [透過文件配置](#透過文件配置)
- [展示](#展示) - [展示](#展示)
- [idlesleeper](#idlesleeper) - [idlesleeper](#idlesleeper)
@ -101,27 +105,7 @@
### 配置文件 ### 配置文件
參見 [config.example.yml](config.example.yml) 了解更多 參見 [config.example.yml](config.example.yml)
```yaml
# autocert 配置
autocert:
email: # ACME 電子郵件
domains: # 域名列表
provider: # DNS 供應商
options: # 供應商個別配置
- ...
# 配置文件 / docker
providers:
include:
- providers.yml
- other_file_1.yml
- ...
docker:
local: $DOCKER_HOST
remote-1: tcp://10.0.2.1:2375
remote-2: ssh://root:1234@10.0.2.2
```
[🔼 返回頂部](#目錄) [🔼 返回頂部](#目錄)