From 92337436bc28383bb8ed341bc9c9235375d96e8d Mon Sep 17 00:00:00 2001 From: Markus Hauschild Date: Thu, 21 Mar 2019 22:12:53 +0100 Subject: [PATCH] docs: cleanup whitespace and remove "---" from json examples --- README.md | 5 ++--- docs/acertmgr.conf | 4 +++- docs/domain.conf | 3 ++- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e245dc5..f4e424e 100644 --- a/README.md +++ b/README.md @@ -56,12 +56,14 @@ All configuration files can use yaml (requires PyYAML) or json syntax. ```yaml --- + # Optional: Authority API endpoint to use # Legacy ACME v1 API with options: #api: v1 #authority: "https://acme-v01.api.letsencrypt.org" #authority: "https://acme-staging.api.letsencrypt.org" #authority_tos_agreement: "https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf" + # Current (default) ACME v2 API with options: #api: v2 #authority: "https://acme-v02.api.letsencrypt.org" @@ -153,13 +155,11 @@ mail.example.com smtp.example.com webmail.example.net *.intra.example.com: perm: '400' format: crt,ca action: '/etc/init.d/postfix reload' - ``` * Example optional global configuration file (JSON syntax): ```json ---- { "mode": "standalone", "port": "80", @@ -175,7 +175,6 @@ mail.example.com smtp.example.com webmail.example.net *.intra.example.com: * Example domain configuration file (JSON syntax): ```json ---- { "mail.example.com": [ { "path": "/etc/postfix/ssl/mail.key", diff --git a/docs/acertmgr.conf b/docs/acertmgr.conf index b031dc1..4bf2684 100644 --- a/docs/acertmgr.conf +++ b/docs/acertmgr.conf @@ -1,10 +1,12 @@ --- + # Optional: Authority API endpoint to use # Legacy ACME v1 API with options: #api: v1 #authority: "https://acme-v01.api.letsencrypt.org" #authority: "https://acme-staging.api.letsencrypt.org" #authority_tos_agreement: "https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf" + # Current (default) ACME v2 API with options: #api: v2 #authority: "https://acme-v02.api.letsencrypt.org" @@ -25,4 +27,4 @@ authority_tos_agreement: "true" # Indicates you agree to the ToS stated by the A #mode: webdir #webdir: /var/www/acme-challenge/ #mode: standalone -#port: 13135 \ No newline at end of file +#port: 13135 diff --git a/docs/domain.conf b/docs/domain.conf index 0b7a42c..191f552 100644 --- a/docs/domain.conf +++ b/docs/domain.conf @@ -1,4 +1,5 @@ --- + mail.example.com: - path: /etc/postfix/ssl/mail.key user: root @@ -61,4 +62,4 @@ mail.example.com smtp.example.com webmail.example.net *.intra.example.com: group: root perm: '400' format: crt,ca - action: '/etc/init.d/postfix reload' \ No newline at end of file + action: '/etc/init.d/postfix reload'