Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v6.2] docs: add ACME and other Setup steps + Setup FAQ #7340

Closed
wants to merge 4 commits into from

Conversation

inertial-frame
Copy link
Contributor

@inertial-frame inertial-frame commented Jun 17, 2021

This PR:

  1. Addresses: Let's Encrypt Documentation unclear #7204
  2. Provides additional instructions to assist with: TLS handschake error | acme can't get a cert for domain #6448
  3. Support wider efforts surrounding: Auto-provision a signed TLS certificate for proxy with LetsEncrypt #4117
  4. Moves the Installation Guide to the new Setup Section. (There are pending changes for that Guide so this should be merged or updated after those other items get merged.)
  5. Addresses: master: teleport --insecure doesn't actually skip cert verification on startup #2040 with updates.

Two previous tickets are relevant:

  1. Add acme to full YAML Reference #6716
  2. Update docs to remove certbot step #6696

I've reviewed most of our existing ACME documentation and it's pretty scant, covers how to automatically acquire a cert through the command line and addressed 443 but not in a consistent way. Ideally, we'd be refactoring all of those items into this one as well but for now, we'll likely leave them in place (we now have a target destination for anything about ACME if we decide to simply redirect/link people to this article - open to that as well).

Also, we mention that we recommend using subdomains in a few places but don't go into much detail about this. The comments above apply to this as well. Ideally all "setup" (read: first time or very common installation steps would be moved in here too).

Copy link
Contributor

@klizhentas klizhentas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The structure of the changes looks good, but let's make a couple of tweaks.

docs/config.json Show resolved Hide resolved
docs/pages/setup/configuration.mdx Outdated Show resolved Hide resolved
@inertial-frame inertial-frame removed this from Doc team: Request for review in Doc review queue Jun 23, 2021
@inertial-frame inertial-frame changed the title [v6.2] docs: add ACME and other Setup steps [v6.2] docs: add ACME and other Setup steps + Setup FAQ Jul 2, 2021
@russjones russjones closed this Sep 1, 2021
@benarent benarent deleted the adam/docs/62configguide branch January 28, 2022 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants