Docs: ACME Overhaul #3421

dargmuesli · 2018-06-01T02:23:38Z

What does this PR do?

Corrects several stylistic inadequacies
Orders topics lexicographically
Merges the two provider tables into one
Fixes some links
Removes duplication in multiple occurrences
Improves explanation of verification methods and problems

Motivation

The obvious stylistic inadequacies in the ACME docs article.

More

Added/updated documentation

Additional Notes

Please have a glance over my updated descriptions of methods and problems and check if they are indeed correct.

dtomcej · 2018-06-04T15:03:04Z

@dargmuesli Can you please rebase this PR off the 1.6 branch instead of master?

Thanks!

dargmuesli · 2018-06-04T15:25:24Z

Sure, did so. I hope I solved the merge conflicts corretly ;)

ldez · 2018-06-04T15:27:54Z

@dargmuesli could you rebase instead merge: git rebase --onto upstream/v1.6 <parent_commit>

dargmuesli · 2018-06-04T15:31:52Z

Oh, sorry. I just followed GitHub's UI there. I guess I can force-push a rebased version?

ldez · 2018-06-04T15:33:22Z

I reseted your branch.
Now you can rebase git rebase --onto upstream/v1.6 HEAD^
And push force.

dargmuesli · 2018-06-04T15:50:48Z

Sorry once again, I was just really confused which branch did what... I hope everything's correct now?

dtomcej · 2018-06-04T18:28:05Z

docs/configuration/acme.md


-See also [Let's Encrypt examples](/user-guide/examples/#lets-encrypt-support) and [Docker & Let's Encrypt user guide](/user-guide/docker-and-lets-encrypt).
+See [Let's Encrypt examples](/user-guide/examples/#lets-encrypt-support) and [Docker & Let's Encrypt user guide](/user-guide/docker-and-lets-encrypt) too.


I personally prefer as well to too

Good idea :)

dtomcej · 2018-06-04T18:28:37Z

docs/configuration/acme.md

-# - Uncomment the line to run on the staging let's encrypt server.
-# - Leave comment to go to prod.
+# Uncomment the line to use Let's Encrypt's staging server,
+# leave comment to go to prod.


leave commented to go to prod

dtomcej · 2018-06-04T18:29:17Z

docs/configuration/acme.md

 #
 # Optional
 #
 # [acme.dnsChallenge]

- # Provider used.
+ # DNS management provider used.


not sure management is needed here

Yeah well, it's arguably unnecessary.

dtomcej · 2018-06-04T18:30:04Z

docs/configuration/acme.md

 #
 # Required
 #
 # provider = "digitalocean"

 # By default, the provider will verify the TXT DNS challenge record before letting ACME verify.
- # If delayBeforeCheck is greater than zero, avoid this & instead just wait so many seconds.
+ # If delayBeforeCheck is greater than zero, this is avoided and the given duration in seconds is waited.


If delayBeforeCheck is greater than zero, this check is delayed for the configured duration in seconds.

dtomcej · 2018-06-04T18:30:40Z

docs/configuration/acme.md

- a JSON file,
- a KV store entry.
+By default, the `provider` will verify the TXT DNS challenge record before letting ACME verify.
+If `delayBeforeCheck` is greater than zero, this is avoided and the given duration in seconds is waited.


same as above

dtomcej · 2018-06-04T18:32:47Z

docs/configuration/acme.md

-
-!!! note
- It's possible to store up to approximately 100 ACME certificates in Consul.
+It is impossible possible to define a wildcard on a wildcard domain (for example `*.*.local.com`).


It is not possible to request a double wildcard certificate for a domain (for example ..local.com)

dtomcej · 2018-06-04T18:33:13Z

docs/configuration/acme.md

-!!! note
- It's possible to store up to approximately 100 ACME certificates in Consul.
+It is impossible possible to define a wildcard on a wildcard domain (for example `*.*.local.com`).
+Due to ACME limitation it is neither possible to define wildcards in SANs (alternative domains). Thus, the wildcard domain has to be defined as a main domain.


it is not possible

dtomcej · 2018-06-04T18:35:11Z

docs/configuration/acme.md

-All DNS providers allow creating ACME wildcard certificates.
-However, many troubles can appear for wildcard domains with SANs.
+!!! note
+ When Træfik is launched in a container the storage file's parent directory needs to be mounted to be able to access the backup file on the host.


launched in a container, the storage

dtomcej · 2018-06-04T18:36:09Z

docs/configuration/acme.md

-
-For example : if `acme.storage` value is `/etc/traefik/acme/acme.json`, the backup file will be named `/etc/traefik/acme/acme.json.bak`.
+ 1. ACME certificates already generated before downtime
+ 1. Expired ACME certificates


Should this be 2. etc?

This should be interpreted as 2. by markdown renderers (GitHub does that). This way one can easily add a new list element without the need to increment all following.

dtomcej · 2018-06-04T18:37:01Z

docs/configuration/acme.md


 !!! note
- When Træfik is launched in a container, do not forget to create a volume of the parent folder to get the backup file on the host.
- Otherwise, the backup file will be permanently deleted when the container is stopped, and Træfik will not be able to generate it again.
+ For new (sub)domains which need Let's Encrypt authentification the default Træfik certificate will be used until Træfik is restarted.


which need Let's Encrypt certificates generated, the default

dtomcej

LGTM

juliens

LGTM

ldez

LGTM

~ Corrected several stylistic inadequacies ~ Ordered topics lexicographically ~ Merged the two provider tables into one ~ Fixed some links ~ Removed duplication in multiple occurrences

@dtomcej

~ Implements requested changes by @dtomcej

dargmuesli · 2018-06-05T12:39:03Z

Nice, thank you guys!

traefiker added area/acme size/L status/0-needs-triage labels Jun 1, 2018

nmengin added the area/documentation label Jun 1, 2018

mmatur added bot/no-merge kind/enhancement a new or improved feature. status/2-needs-review and removed status/0-needs-triage labels Jun 4, 2018

mmatur added this to the 1.6 milestone Jun 4, 2018

mmatur added size/S size/L and removed size/L size/S labels Jun 4, 2018

dargmuesli changed the base branch from master to v1.6 June 4, 2018 15:20

dargmuesli requested review from a team as code owners June 4, 2018 15:24

ldez changed the base branch from v1.6 to master June 4, 2018 15:32

ldez changed the base branch from master to v1.6 June 4, 2018 15:54

ldez removed the bot/no-merge label Jun 4, 2018

dtomcej suggested changes Jun 4, 2018

View reviewed changes

traefiker added the contributor/waiting-for-corrections label Jun 4, 2018

dtomcej approved these changes Jun 4, 2018

View reviewed changes

traefiker removed the contributor/waiting-for-corrections label Jun 4, 2018

ldez added the bot/no-merge label Jun 4, 2018

ldez self-requested a review June 4, 2018 20:40

juliens approved these changes Jun 5, 2018

View reviewed changes

ldez approved these changes Jun 5, 2018

View reviewed changes

ldez added status/3-needs-merge and removed bot/no-merge status/2-needs-review labels Jun 5, 2018

traefiker added bot/merge-retry-1 status/4-merge-in-progress and removed bot/merge-retry-1 labels Jun 5, 2018

dargmuesli and others added 3 commits June 5, 2018 08:32

Docs: ACME Overhaul

6e3cc4f

~ Corrected several stylistic inadequacies ~ Ordered topics lexicographically ~ Merged the two provider tables into one ~ Fixed some links ~ Removed duplication in multiple occurrences

Requested Changes

71fd111

~ Implements requested changes by @dtomcej

review: minor changes.

0ae492d

traefiker removed the status/4-merge-in-progress label Jun 5, 2018

traefiker merged commit f317e50 into traefik:v1.6 Jun 5, 2018

traefiker removed the status/3-needs-merge label Jun 5, 2018

dargmuesli deleted the docs_acme branch March 20, 2019 04:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs: ACME Overhaul #3421

Docs: ACME Overhaul #3421

dargmuesli commented Jun 1, 2018

dtomcej commented Jun 4, 2018

dargmuesli commented Jun 4, 2018

ldez commented Jun 4, 2018

dargmuesli commented Jun 4, 2018

ldez commented Jun 4, 2018 •

edited

Loading

dargmuesli commented Jun 4, 2018

dtomcej Jun 4, 2018

dargmuesli Jun 4, 2018

dtomcej Jun 4, 2018

dtomcej Jun 4, 2018

dargmuesli Jun 4, 2018

dtomcej Jun 4, 2018

dtomcej Jun 4, 2018

dtomcej Jun 4, 2018

dtomcej Jun 4, 2018

dtomcej Jun 4, 2018

dtomcej Jun 4, 2018

dargmuesli Jun 4, 2018 •

edited

Loading

dtomcej Jun 4, 2018

dtomcej left a comment

juliens left a comment

ldez left a comment

dargmuesli commented Jun 5, 2018


		See also [Let's Encrypt examples](/user-guide/examples/#lets-encrypt-support) and [Docker & Let's Encrypt user guide](/user-guide/docker-and-lets-encrypt).
		See [Let's Encrypt examples](/user-guide/examples/#lets-encrypt-support) and [Docker & Let's Encrypt user guide](/user-guide/docker-and-lets-encrypt) too.

Docs: ACME Overhaul #3421

Docs: ACME Overhaul #3421

Conversation

dargmuesli commented Jun 1, 2018

What does this PR do?

Motivation

More

Additional Notes

dtomcej commented Jun 4, 2018

dargmuesli commented Jun 4, 2018

ldez commented Jun 4, 2018

dargmuesli commented Jun 4, 2018

ldez commented Jun 4, 2018 • edited Loading

dargmuesli commented Jun 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dargmuesli Jun 4, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dtomcej left a comment

Choose a reason for hiding this comment

juliens left a comment

Choose a reason for hiding this comment

ldez left a comment

Choose a reason for hiding this comment

dargmuesli commented Jun 5, 2018

ldez commented Jun 4, 2018 •

edited

Loading

dargmuesli Jun 4, 2018 •

edited

Loading