Standardize ACME instruction details #9556
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ptgott
force-pushed
the
paul.gottschling/6448-tls-clarity
branch
2 times, most recently
from
c83b704 to
2995ced
Compare
ptgott
force-pushed
the
paul.gottschling/6448-tls-clarity
branch
from
2995ced to
828b036
Compare
ptgott
force-pushed
the
paul.gottschling/6448-tls-clarity
branch
3 times, most recently
from
234d280 to
3118310
Compare
ptgott
force-pushed
the
paul.gottschling/6448-tls-clarity
branch
from
3118310 to
67a8c34
Compare
zmb3
reviewed
Feb 4, 2022
|
|
||
| Download the latest version of Teleport for your platform from our | ||
| [downloads page](https://goteleport.com/teleport/download). | ||
|
|
||
| Teleport requires a valid TLS certificate to operate and can fetch one automatically | ||
| using Let's Encrypt [ACME](https://letsencrypt.org/how-it-works/) protocol. | ||
|
|
||
| We will assume that you have configured DNS records for `teleport.example.com` | ||
| and `*.teleport.example.com` to point to the Teleport node. |
There was a problem hiding this comment.
Suggested change
| and `*.teleport.example.com` to point to the Teleport node. | |
| and `*.teleport.example.com` to point to the Teleport proxy. |
Right?
docs/pages/includes/acme.mdx
Outdated
| @@ -0,0 +1,21 @@ | |||
| Let's Encrypt verifies that you control the domain name of your Teleport deployment by communicating with the HTTPS server listening on port 443 of your Teleport Proxy Service. | |||
|
|
|||
| You can configure Teleport to complete the Let's Encrypt verification process—called the ACME protocol—by running the following `teleport configure` command, where `tele.example.com` is the domain name of your Teleport cluster and `[email protected]` is an email address used for notifications (you can use any domain): | |||
There was a problem hiding this comment.
This reads a little bit awkward to me. My understanding is that teleport configure doesn't actually configure anything, but rather spits out some configuration that you can then paste into your teleport.yaml.
The way this reads, it sounds like teleport configure is actually modifying the file for you.
| @@ -3,24 +3,13 @@ Download the latest version of Teleport for your platform from our | |||
| installation [instructions](../../installation.mdx). | |||
|
|
|||
| Teleport requires a valid TLS certificate to operate and can fetch one automatically | |||
| using Let's Encrypt [ACME](https://letsencrypt.org/how-it-works/) protocol. We | |||
| using Let's Encrypt. We | |||
There was a problem hiding this comment.
Strange place for a line break.
ptgott
force-pushed
the
paul.gottschling/6448-tls-clarity
branch
2 times, most recently
from
aec815b to
868701e
Compare
zmb3
approved these changes
Feb 10, 2022
ptgott
force-pushed
the
paul.gottschling/6448-tls-clarity
branch
from
868701e to
7e908fe
Compare
|
@xinding33 @r0mant would you have time to give this a look? Thanks! |
ptgott
force-pushed
the
paul.gottschling/6448-tls-clarity
branch
5 times, most recently
from
09539df to
999f41b
Compare
ptgott
force-pushed
the
paul.gottschling/6448-tls-clarity
branch
from
999f41b to
44966f0
Compare
Our Getting Started guides often include instructions for configuring Let's Encrypt and ACME before starting Teleport, but not all of these instructions have the same level of detail, and some are missing some context around how Teleport uses ACME and why you need to open port 443 on your Proxy Service host. This change adds an include that spells out these instructions and invokes the include in the appropriate guides. The intention was to include as much relevant information within the guides themselves to prevent the reader from having to navigate to other pages. Closes #6448
- Substitute "proxy" for "node" where it was incorrectly used - Some small stylistic fixes - Clarify that "teleport configure" does not write the config itself
ptgott
force-pushed
the
paul.gottschling/6448-tls-clarity
branch
from
44966f0 to
aa07670
Compare
benarent
approved these changes
Mar 2, 2022
|
@ptgott Looks like this was approved, can we merge? |
This was referenced Mar 3, 2022
ptgott
added a commit
that referenced
this pull request
Mar 4, 2022
* Standardize ACME instruction details Our Getting Started guides often include instructions for configuring Let's Encrypt and ACME before starting Teleport, but not all of these instructions have the same level of detail, and some are missing some context around how Teleport uses ACME and why you need to open port 443 on your Proxy Service host. This change adds an include that spells out these instructions and invokes the include in the appropriate guides. The intention was to include as much relevant information within the guides themselves to prevent the reader from having to navigate to other pages. Closes #6448 * Respond to PR feedback - Substitute "proxy" for "node" where it was incorrectly used - Some small stylistic fixes - Clarify that "teleport configure" does not write the config itself
ptgott
added a commit
that referenced
this pull request
Mar 4, 2022
* Standardize ACME instruction details Our Getting Started guides often include instructions for configuring Let's Encrypt and ACME before starting Teleport, but not all of these instructions have the same level of detail, and some are missing some context around how Teleport uses ACME and why you need to open port 443 on your Proxy Service host. This change adds an include that spells out these instructions and invokes the include in the appropriate guides. The intention was to include as much relevant information within the guides themselves to prevent the reader from having to navigate to other pages. Closes #6448 * Respond to PR feedback - Substitute "proxy" for "node" where it was incorrectly used - Some small stylistic fixes - Clarify that "teleport configure" does not write the config itself
ptgott
added a commit
that referenced
this pull request
Mar 9, 2022
Guides to getting started with Teleport on various platforms recommend creating a DNS record for *.teleport.com. It would help prospective users to know why this is needed. This change adds context for why Application Access requires a wildcard subdomain. Fixes #5378 When addressing conflicts with #9556, it turned out that the acme.mdx partial would not render inside the Tabs component within the start-auth-proxy.mdx partial. I have copied the contents of acme.mdx to use inside start-auth-proxy.mdx until we can fix this issue. I also made some minor edits to acme.mdx while fixing these conflicts.
ptgott
added a commit
that referenced
this pull request
Mar 9, 2022
Backports #9556 * Standardize ACME instruction details Our Getting Started guides often include instructions for configuring Let's Encrypt and ACME before starting Teleport, but not all of these instructions have the same level of detail, and some are missing some context around how Teleport uses ACME and why you need to open port 443 on your Proxy Service host. This change adds an include that spells out these instructions and invokes the include in the appropriate guides. The intention was to include as much relevant information within the guides themselves to prevent the reader from having to navigate to other pages. Closes #6448 * Respond to PR feedback - Substitute "proxy" for "node" where it was incorrectly used - Some small stylistic fixes - Clarify that "teleport configure" does not write the config itself
ptgott
added a commit
that referenced
this pull request
Mar 9, 2022
start-auth-proxy.mdx is a partial used by a number of Database Access guides. After PR #9556, the partial included garbled instructions for setting up Teleport with Let's Encrypt. This change edits these instructions for clarity.
ptgott
added a commit
that referenced
this pull request
Mar 10, 2022
start-auth-proxy.mdx is a partial used by a number of Database Access guides. After PR #9556, the partial included garbled instructions for setting up Teleport with Let's Encrypt. This change edits these instructions for clarity.
ptgott
added a commit
that referenced
this pull request
Mar 10, 2022
start-auth-proxy.mdx is a partial used by a number of Database Access guides. After PR #9556, the partial included garbled instructions for setting up Teleport with Let's Encrypt. This change edits these instructions for clarity.
ptgott
added a commit
that referenced
this pull request
Mar 10, 2022
Backports #9556 * Standardize ACME instruction details Our Getting Started guides often include instructions for configuring Let's Encrypt and ACME before starting Teleport, but not all of these instructions have the same level of detail, and some are missing some context around how Teleport uses ACME and why you need to open port 443 on your Proxy Service host. This change adds an include that spells out these instructions and invokes the include in the appropriate guides. The intention was to include as much relevant information within the guides themselves to prevent the reader from having to navigate to other pages. Closes #6448 * Respond to PR feedback - Substitute "proxy" for "node" where it was incorrectly used - Some small stylistic fixes - Clarify that "teleport configure" does not write the config itself
ptgott
added a commit
that referenced
this pull request
Mar 14, 2022
Backports #9556 * Standardize ACME instruction details Our Getting Started guides often include instructions for configuring Let's Encrypt and ACME before starting Teleport, but not all of these instructions have the same level of detail, and some are missing some context around how Teleport uses ACME and why you need to open port 443 on your Proxy Service host. This change adds an include that spells out these instructions and invokes the include in the appropriate guides. The intention was to include as much relevant information within the guides themselves to prevent the reader from having to navigate to other pages. Closes #6448 * Respond to PR feedback - Substitute "proxy" for "node" where it was incorrectly used - Some small stylistic fixes - Clarify that "teleport configure" does not write the config itself
ptgott
added a commit
that referenced
this pull request
Mar 16, 2022
Backports #9556 * Standardize ACME instruction details Our Getting Started guides often include instructions for configuring Let's Encrypt and ACME before starting Teleport, but not all of these instructions have the same level of detail, and some are missing some context around how Teleport uses ACME and why you need to open port 443 on your Proxy Service host. This change adds an include that spells out these instructions and invokes the include in the appropriate guides. The intention was to include as much relevant information within the guides themselves to prevent the reader from having to navigate to other pages. Closes #6448 * Respond to PR feedback - Substitute "proxy" for "node" where it was incorrectly used - Some small stylistic fixes - Clarify that "teleport configure" does not write the config itself
ptgott
added a commit
that referenced
this pull request
Mar 18, 2022
Backports #9556 * Standardize ACME instruction details Our Getting Started guides often include instructions for configuring Let's Encrypt and ACME before starting Teleport, but not all of these instructions have the same level of detail, and some are missing some context around how Teleport uses ACME and why you need to open port 443 on your Proxy Service host. This change adds an include that spells out these instructions and invokes the include in the appropriate guides. The intention was to include as much relevant information within the guides themselves to prevent the reader from having to navigate to other pages. Closes #6448 * Respond to PR feedback - Substitute "proxy" for "node" where it was incorrectly used - Some small stylistic fixes - Clarify that "teleport configure" does not write the config itself
ptgott
added a commit
that referenced
this pull request
Mar 18, 2022
Backports #9556 * Standardize ACME instruction details Our Getting Started guides often include instructions for configuring Let's Encrypt and ACME before starting Teleport, but not all of these instructions have the same level of detail, and some are missing some context around how Teleport uses ACME and why you need to open port 443 on your Proxy Service host. This change adds an include that spells out these instructions and invokes the include in the appropriate guides. The intention was to include as much relevant information within the guides themselves to prevent the reader from having to navigate to other pages. Closes #6448 * Respond to PR feedback - Substitute "proxy" for "node" where it was incorrectly used - Some small stylistic fixes - Clarify that "teleport configure" does not write the config itself
Closed
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our Getting Started guides often include instructions for
configuring Let's Encrypt and ACME before starting
Teleport, but not all of these instructions have the same
level of detail, and some are missing some context around
how Teleport uses ACME and why you need to open port 443 on
your Proxy Service host. This change adds an include that
spells out these instructions and invokes the include in the
appropriate guides.
The intention was to include as much relevant information within
the guides themselves to prevent the reader from having to
navigate to other pages.
Closes #6448