From 9bfd904e9f59e0e24504f4d78239218a54cc1eda Mon Sep 17 00:00:00 2001 From: Steven Martin Date: Tue, 1 Oct 2024 05:56:18 -0400 Subject: [PATCH 1/3] docs: update server access guides --- .../server-access/guides/jetbrains-sftp.mdx | 2 +- .../enroll-resources/server-access/guides/vscode.mdx | 2 +- docs/pages/includes/edition-prereqs-tabs-not-admin.mdx | 10 ++++++++++ 3 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 docs/pages/includes/edition-prereqs-tabs-not-admin.mdx diff --git a/docs/pages/enroll-resources/server-access/guides/jetbrains-sftp.mdx b/docs/pages/enroll-resources/server-access/guides/jetbrains-sftp.mdx index 6565d813986b0..a29b79c275ad8 100644 --- a/docs/pages/enroll-resources/server-access/guides/jetbrains-sftp.mdx +++ b/docs/pages/enroll-resources/server-access/guides/jetbrains-sftp.mdx @@ -12,7 +12,7 @@ This guide explains how to use Teleport and a JetBrains IDE to access files with ## Prerequisites -(!docs/pages/includes/edition-prereqs-tabs.mdx!) +(!docs/pages/includes/edition-prereqs-tabs-not-admin.mdx!) - JetBrains IDE like PyCharm, IntelliJ, GoLand etc. See [Products](https://www.jetbrains.com/products/#type=ide) for a full list of JetBrains IDEs. - One or more Teleport SSH Service instances. If you have not yet done this, diff --git a/docs/pages/enroll-resources/server-access/guides/vscode.mdx b/docs/pages/enroll-resources/server-access/guides/vscode.mdx index a521a13761703..ae8d33e1d975f 100644 --- a/docs/pages/enroll-resources/server-access/guides/vscode.mdx +++ b/docs/pages/enroll-resources/server-access/guides/vscode.mdx @@ -8,7 +8,7 @@ This guide explains how to use Teleport and Visual Studio Code's remote SSH exte ## Prerequisites -(!docs/pages/includes/edition-prereqs-tabs.mdx!) +(!docs/pages/includes/edition-prereqs-tabs-not-admin.mdx!) - OpenSSH client. - Visual Studio Code with the [Remote - SSH extension](https://code.visualstudio.com/docs/remote/ssh#_system-requirements) diff --git a/docs/pages/includes/edition-prereqs-tabs-not-admin.mdx b/docs/pages/includes/edition-prereqs-tabs-not-admin.mdx new file mode 100644 index 0000000000000..844f19ac5c8f9 --- /dev/null +++ b/docs/pages/includes/edition-prereqs-tabs-not-admin.mdx @@ -0,0 +1,10 @@ +{{ version="(=teleport.version=)" }} + +- A running Teleport cluster version {{ version }} or above. If you want to get started with Teleport, [sign + up](https://goteleport.com/signup) for a free trial or [set up a demo + environment](../admin-guides/deploy-a-cluster/linux-demo.mdx). + +- The `tsh` client tool. + + Visit [Installation](../installation.mdx) for instructions on downloading + `tsh`. From 628e3a3a6f11a492aa4377adaa3cc8e052f8b8b5 Mon Sep 17 00:00:00 2001 From: Steven Martin Date: Tue, 1 Oct 2024 10:24:27 -0400 Subject: [PATCH 2/3] docs: remove version 12.1 reference --- docs/pages/admin-guides/access-controls/idps.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/admin-guides/access-controls/idps.mdx b/docs/pages/admin-guides/access-controls/idps.mdx index cf58e927afe91..347b7840b9391 100644 --- a/docs/pages/admin-guides/access-controls/idps.mdx +++ b/docs/pages/admin-guides/access-controls/idps.mdx @@ -3,8 +3,8 @@ title: Configure Teleport as an identity provider description: How to set up Teleport's identity provider functionality --- -Since Teleport 12.1 users can authenticate to both internal and external applications -through the use of a built in identity provider. +Users can authenticate to both internal and external applications +through the use of a built in identity provider in Teleport. - [SAML Guide](./idps/saml-guide.mdx): A guide for setting up an example application to integration with the SAML identity provider. - [SAML Attribute Mapping](./idps/saml-attribute-mapping.mdx): A reference on how attribute mapping works in Teleport and how to From ab2eb28c89d4320c59c594d8766533b9fa34d235 Mon Sep 17 00:00:00 2001 From: Steven Martin Date: Tue, 1 Oct 2024 10:24:56 -0400 Subject: [PATCH 3/3] docs: update api user --- docs/pages/admin-guides/api/getting-started.mdx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/pages/admin-guides/api/getting-started.mdx b/docs/pages/admin-guides/api/getting-started.mdx index 833cf2752d5a6..4f9287fc5e14e 100644 --- a/docs/pages/admin-guides/api/getting-started.mdx +++ b/docs/pages/admin-guides/api/getting-started.mdx @@ -31,9 +31,7 @@ Here are the steps we'll walkthrough: Create a user `api-admin` with the built-in role `editor`: ```code -# Run this directly on your Auth Server unless you are using Teleport Cloud -# Add a user and login via the Proxy Service -$ sudo tctl users add api-admin --roles=editor +$ tctl users add api-admin --roles=editor ``` ## Step 2/3. Generate client credentials