Skip to content

Commit

Permalink
[v8] docs backports (#12895)
Browse files Browse the repository at this point in the history
* docs: remove mention of Teleport Pro from FAQ (#12702)

Closes #7626

* docs: remove _ from valid subdomain characters (#12697)

Fixes #10137

* docs: add missing whitespace (#12696)

Fixes #10337
  • Loading branch information
zmb3 authored Jun 1, 2022
1 parent 04f44ca commit 576d5fe
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/pages/application-access/guides/connecting-apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ a reverse tunnel.

### Application name

An application name should make a valid sub-domain (\<=63 characters, no spaces, only `a-z 0-9 _ -` allowed).
An application name should make a valid sub-domain (\<=63 characters, no spaces, only `a-z 0-9 -` allowed).

After Teleport is running, users can access the app at `app-name.proxy_public_addr.com`
e.g. `grafana.teleport.example.com`. You can also override `public_addr` e.g
Expand Down
29 changes: 18 additions & 11 deletions docs/pages/faq.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Teleport FAQ
description: Frequently Asked Questions about using Teleport for SSH and Kubernetes access
description: Frequently asked questions about using Teleport
h1: FAQ
---

Expand Down Expand Up @@ -33,20 +33,26 @@ section of the Admin Manual.

### Can individual nodes create reverse tunnels to a proxy server without creating a new cluster?

This was a popular customer [request](https://github.com/gravitational/teleport/issues/803) that was added in Teleport version 4.0.
Once you've upgraded your Teleport Cluster, change the node config option `--auth-server` to point to web proxy address (this would be `public_addr` and `web_listen_addr`
in file configuration). For more information, see [Adding Nodes to the Cluster](./setup/admin/adding-nodes.mdx).
This was a popular customer
[request](https://github.com/gravitational/teleport/issues/803) that was added
in Teleport version 4.0. Change the node config option `--auth-server` flag when
running the `teleport` daemon on an agent to point to the Proxy Service address
(this would be `public_addr` and `web_listen_addr` in file configuration). For
more information, see
[Adding Nodes to the Cluster](./setup/admin/adding-nodes.mdx).

### Can nodes use a single port for reverse tunnels?

Yes, Teleport supports tunnel multiplexing on a single port. Set the `tunnel_listen_addr` to use the same port as the `web_listen_addr` address setting in the `proxy_service` configuration. Teleport will automatically use multiplexing with that configuration.
Yes, Teleport supports tunnel multiplexing on a single port. Set the
`tunnel_listen_addr` to use the same port as the `web_listen_addr` address
setting in the `proxy_service` configuration. Teleport will automatically use
multiplexing with that configuration.

## How is Open Source different from Enterprise?

Teleport provides three offerings:

- Open Source - Apache 2 License, self-hosted.
- Enterprise - self-hosted or cloud, commercial license.
Open Source Teleport is licensed under the Apache 2 License, and must be
self-hosted. Enterprise Teleport is commercially licensed and is available in
both self-hosted and cloud deployments.

<table>
<thead>
Expand Down Expand Up @@ -168,8 +174,9 @@ commercial versions of Teleport may or may not be configured to send anonymized
- Anonymized user ID: SHA256 hash of a username with a randomly generated prefix.
- Anonymized server ID: SHA256 hash of a server IP with a randomly generated prefix.

This allows Teleport Pro to print a warning if users are exceeding the usage limits
of their license. The reporting library code is [on Github](https://github.com/gravitational/reporting).
This allows Teleport to print a warning if users are exceeding the usage limits
of their license. The reporting library code is
[on GitHub](https://github.com/gravitational/reporting).

Reach out to `[email protected]` if you have questions about the commercial
edition of Teleport.
4 changes: 2 additions & 2 deletions docs/pages/server-access/guides/tsh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ In this example, we're creating a certificate with a TTL of one hour for the

```code
# To be executed on a Teleport Auth Server
$ tctl auth sign --ttl=1h--user=jenkins --out=jenkins.pem
$ tctl auth sign --ttl=1h --user=jenkins --out=jenkins.pem
```

</ScopedBlock>
Expand All @@ -362,7 +362,7 @@ $ tctl auth sign --ttl=1h--user=jenkins --out=jenkins.pem
```code
# Log in to your Teleport Cloud cluster so you can use tctl locally.
$ tsh login --proxy=myinstance.teleport.sh [email protected]
$ tctl auth sign --ttl=1h--user=jenkins --out=jenkins.pem
$ tctl auth sign --ttl=1h --user=jenkins --out=jenkins.pem
```

</ScopedBlock>
Expand Down

0 comments on commit 576d5fe

Please sign in to comment.