Update desktop docs #1374
Update desktop docs #1374
Conversation
✅ Deploy Preview for pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@kenjenkins just realized this Pr includes a Zero image. We should probably remove it unless you don't think we need to backport this. |
| - **macOS**: Open the `dmg` and move the binary to **Applications**. Interact with the client from the system tray icon. | ||
|
|
||
| <details> | ||
| <summary>Autostart Pomerium Desktop</summary> |
There was a problem hiding this comment.
I think we should keep this information available somewhere, but I'd agree that this page might not be the best place for it.
What do you think about moving it onto the https://www.pomerium.com/docs/deploy/clients/pomerium-desktop page, along with the installation instructions?
| :::note TCP Terminology | ||
|
|
||
| 1. Specify this new Route as a TCP Route by prefixing `tcp+` in the **From** field, along with a port suffix. | ||
| In this document, a "TCP route" refers to a route configured to accept TCP connections. |
There was a problem hiding this comment.
I think this is a good idea — it's natural for a reader to have the question "what's a TCP route" here.
I think we could make this even clearer by comparing with "regular" http/https routes.
What do you think of something like this?
:::info What's a TCP route?
A TCP route is for use with upstream services that don't speak HTTP — for example
SSH, Redis, or MySQL. With a TCP route, the entire connection is proxied to the
upstream service, rather than each individual request separately.
In Pomerium, TCP routes are denoted with a `tcp+` prefix in the route's **From** URL.|
|
||
| <Tabs> | ||
| <TabItem value="Pomerium Zero" label="Pomerium Zero"> |
There was a problem hiding this comment.
I like the Zero screenshot, but I think it might be better to add this in a separate PR, so we can go ahead and backport this one.
|
|
||
| **Tags**: Use tags to sort and organize your TCP routes. | ||
|  | ||
|
|
||
| :::note Long-lived connections behavior |
There was a problem hiding this comment.
This admonition feels out of place to me. I think it might make sense to remove it, so this section can focus on the "how-to".
Co-authored-by: Kenneth Jenkins <[email protected]>
Co-authored-by: Kenneth Jenkins <[email protected]>
|
|
||
| Copy the shortcut for the Pomerium Desktop app into `C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup`. | ||
| The port suffix appended to the **From** route is not used to connect to the Pomerium Proxy service from the internet; this will always be port 443 (unless otherwise defined in the configuration file). |
There was a problem hiding this comment.
Sorry, I think I deleted a pending comment somehow. I think this could be made a little clearer, along the lines of:
:::tip
The port number in the route **From** URL is not used in the initial connection
to Pomerium itself. This connection will still use port 443, unless you use a
bastion host (see [Advanced configuration](#advanced-configuration) below).Co-authored-by: Kenneth Jenkins <[email protected]>
* updates desktop images and text * runs prettier * removes tabs, adds better images * fixes links * Update content/docs/capabilities/tcp/client.mdx Co-authored-by: Kenneth Jenkins <[email protected]> * Update content/docs/capabilities/tcp/client.mdx Co-authored-by: Kenneth Jenkins <[email protected]> * Update content/docs/capabilities/tcp/client.mdx Co-authored-by: Kenneth Jenkins <[email protected]> * adds changes based on feedback * runs prettier --------- Co-authored-by: Kenneth Jenkins <[email protected]>
Update desktop docs (#1374) * updates desktop images and text * runs prettier * removes tabs, adds better images * fixes links * Update content/docs/capabilities/tcp/client.mdx * Update content/docs/capabilities/tcp/client.mdx * Update content/docs/capabilities/tcp/client.mdx * adds changes based on feedback * runs prettier --------- Co-authored-by: zachary painter <[email protected]> Co-authored-by: Kenneth Jenkins <[email protected]>
@kenjenkins please let me know if you'd prefer different screenshots or more details for this blurb.
Resolves #1366