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.

Sign up for GitHub

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

Jump to bottom

Find an alternative to requiring DNS record creation in the Linux quickstart guide #9077

Closed
ptgott opened this issue Nov 19, 2021 · 0 comments · Fixed by #9346
Closed

Find an alternative to requiring DNS record creation in the Linux quickstart guide #9077

ptgott opened this issue Nov 19, 2021 · 0 comments · Fixed by #9346
Assignees
@ptgott
Labels
documentation friction-log
Milestone
Documentation: Ma...

Comments

@ptgott
Copy link
Contributor

ptgott commented Nov 19, 2021

Details

In the "Getting started on a Linux Server" guide, one prerequisite is a registered domain name. The guide instructs users to set up two DNS A records, which Let's Encrypt needs to provided a signed certificate via the ACME protocol.

While this is the sort of workflow an engineer would implement in a production or staging environment, requiring DNS changes can present friction to someone looking to set up Teleport quickly to see how it works, since not every user has the required access or resources within their organization to create DNS records.

One step we could take is to leave the guide as it is but position it as more of an advanced recipe than a quick start guide. The Docker Compose guide already lets users try out Teleport commands in a readymade environment. Is there a way to direct casually interested, first-time users to this guide, rather than the Linux guide? It would also help to know how many first-time users tend to follow the "Getting started on a Linux Server" guide.

Category

  • Improve Existing
@ptgott ptgott self-assigned this Dec 2, 2021
@ptgott ptgott mentioned this issue Dec 10, 2021
Merged
@ptgott ptgott mentioned this issue Dec 13, 2021
Closed
ptgott added a commit to ptgott/teleport that referenced this issue Dec 15, 2021
@ptgott
Clarify the Linux Getting Started guide
2501dc7 
- Prerequisites: Make the requirement for a DNS server a bit
  more generalized.
- Add an admonition box directing users expecting a local
  evaluation setup to our Docker Compose guide.
- Add a bit more context around how ACME works
- Move "Configure DNS" before "Configure Teleport" to provide a
  clearer order of tasks.
- Add a bit of explanation for why a user would create DNS
  records.
- Add some explanation for how "teleport configure" sets up
  TLS.
- Add a "Start Teleport" H3 section to separate this step from
  previous ones.
- Various minor additions to add clarity.

Closes gravitational#9077 since it refers users without access to a DNS server
to the Docker Compose guide.

Closes gravitational#9083
ptgott added a commit that referenced this issue Dec 15, 2021
@ptgott
Clarify the Linux Getting Started guide (#9346)
5cb3c8a 
- Prerequisites: Make the requirement for a DNS server a bit
  more generalized.
- Add an admonition box directing users expecting a local
  evaluation setup to our Docker Compose guide.
- Add a bit more context around how ACME works
- Move "Configure DNS" before "Configure Teleport" to provide a
  clearer order of tasks.
- Add a bit of explanation for why a user would create DNS
  records.
- Add some explanation for how "teleport configure" sets up
  TLS.
- Add a "Start Teleport" H3 section to separate this step from
  previous ones.
- Various minor additions to add clarity.

Closes #9077 since it refers users without access to a DNS server
to the Docker Compose guide.

Closes #9083
ptgott added a commit to ptgott/teleport that referenced this issue Dec 15, 2021
@ptgott
Clarify the Linux Getting Started guide
6fc8f05 
- Prerequisites: Make the requirement for a DNS server a bit
  more generalized.
- Add an admonition box directing users expecting a local
  evaluation setup to our Docker Compose guide.
- Add a bit more context around how ACME works
- Move "Configure DNS" before "Configure Teleport" to provide a
  clearer order of tasks.
- Add a bit of explanation for why a user would create DNS
  records.
- Add some explanation for how "teleport configure" sets up
  TLS.
- Add a "Start Teleport" H3 section to separate this step from
  previous ones.
- Various minor additions to add clarity.

Closes gravitational#9077 since it refers users without access to a DNS server
to the Docker Compose guide.

Closes gravitational#9083
@ptgott ptgott mentioned this issue Dec 15, 2021
Merged
ptgott added a commit that referenced this issue Dec 15, 2021
@ptgott
Clarify the Linux Getting Started guide
f1aa956 
- Prerequisites: Make the requirement for a DNS server a bit
  more generalized.
- Add an admonition box directing users expecting a local
  evaluation setup to our Docker Compose guide.
- Add a bit more context around how ACME works
- Move "Configure DNS" before "Configure Teleport" to provide a
  clearer order of tasks.
- Add a bit of explanation for why a user would create DNS
  records.
- Add some explanation for how "teleport configure" sets up
  TLS.
- Add a "Start Teleport" H3 section to separate this step from
  previous ones.
- Various minor additions to add clarity.

Closes #9077 since it refers users without access to a DNS server
to the Docker Compose guide.

Closes #9083
ptgott added a commit that referenced this issue Dec 16, 2021
@ptgott
Clarify the Linux Getting Started guide
a67edcf 
- Prerequisites: Make the requirement for a DNS server a bit
  more generalized.
- Add an admonition box directing users expecting a local
  evaluation setup to our Docker Compose guide.
- Add a bit more context around how ACME works
- Move "Configure DNS" before "Configure Teleport" to provide a
  clearer order of tasks.
- Add a bit of explanation for why a user would create DNS
  records.
- Add some explanation for how "teleport configure" sets up
  TLS.
- Add a "Start Teleport" H3 section to separate this step from
  previous ones.
- Various minor additions to add clarity.

Closes #9077 since it refers users without access to a DNS server
to the Docker Compose guide.

Closes #9083
ptgott added a commit that referenced this issue Dec 16, 2021
@ptgott
Clarify the Linux Getting Started guide (#9429)
63fcd50 
- Prerequisites: Make the requirement for a DNS server a bit
  more generalized.
- Add an admonition box directing users expecting a local
  evaluation setup to our Docker Compose guide.
- Add a bit more context around how ACME works
- Move "Configure DNS" before "Configure Teleport" to provide a
  clearer order of tasks.
- Add a bit of explanation for why a user would create DNS
  records.
- Add some explanation for how "teleport configure" sets up
  TLS.
- Add a "Start Teleport" H3 section to separate this step from
  previous ones.
- Various minor additions to add clarity.

Closes #9077 since it refers users without access to a DNS server
to the Docker Compose guide.

Closes #9083
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ptgott ptgott

Labels
documentation friction-log
Projects
None yet
Milestone
Documentation: Make it easier to get ...
Development

Successfully merging a pull request may close this issue.

Clarify the Linux Getting Started guide ptgott/teleport
1 participant
@ptgott