Skip to content

Commit 0f3edb3

Browse files
committed
updates desktop images and text
1 parent 182b414 commit 0f3edb3

File tree

5 files changed

+18
-55
lines changed

5 files changed

+18
-55
lines changed

content/docs/capabilities/tcp/client.mdx

+18-55
Original file line numberDiff line numberDiff line change
@@ -59,79 +59,33 @@ The example below demonstrates a route to the SSH service on the host running th
5959
6060
See the "Configure Routes" section of [TCP Support](/docs/capabilities/tcp#configure-routes) for more detailed information on TCP routes.
6161
62-
## TCP Client Software
62+
## Access TCP route with client software
6363
6464
You can connect to this route with either the Pomerium CLI or Pomerium Desktop client.
6565
6666
<Tabs>
6767
6868
<TabItem value="Pomerium Desktop" label="Pomerium Desktop">
6969
70-
### Install
70+
### Install Pomerium Desktop
7171
7272
Download the latest release from [GitHub](https://github.com/pomerium/desktop-client/releases).
7373
7474
- **Windows**: The installer `.exe` file will install and open the Desktop Client. Right click on the system tray icon to interact with it.
7575
- **Linux**: We provide Linux binaries as `.AppImage` files, which can be executed in place or managed with a tool like [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher). Interact with the client from the system tray icon.
7676
- **macOS**: Open the `dmg` and move the binary to **Applications**. Interact with the client from the system tray icon.
7777

78-
<details>
79-
<summary>Autostart Pomerium Desktop</summary>
80-
81-
If you want Pomerium Desktop to start automatically when you log in to your computer, follow the steps below for your operating system.
82-
83-
<Tabs>
84-
<TabItem value="windows" label="Windows">
85-
86-
#### Autostart for all users
87-
88-
Copy the shortcut for the Pomerium Desktop app into `C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup`.
89-
90-
#### Autostart for your user
91-
92-
Copy the shortcut for the Pomerium Desktop app into `C:\Users\username\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup`, replacing `username` with your username.
93-
94-
---
95-
96-
Windows 11 also offers a GUI method, documented by [windowscentral.com](https://www.windowscentral.com/how-launch-apps-automatically-during-login-windows-11)
97-
98-
</TabItem>
99-
<TabItem value="mac" label="MacOS">
100-
101-
1. From **System Preferences**, select **Users & Groups**.
102-
103-
1. Click **Login Items** near the top, then the **+** button towards the bottom of the window.
104-
105-
1. Select Pomerium Desktop from the Applications folder.
106-
107-
</TabItem>
108-
<TabItem value="gnome" label="Linux (Gnome)">
109-
110-
The easiest way to autostart user applications in the Gnome Desktop Environment is by using the Tweaks application. Gnome documents this process well, so we won't replicate it here. See [Gnome's documentation](https://help.gnome.org/users/gnome-help/stable/shell-apps-auto-start.html) for more information.
111-
112-
</TabItem>
113-
<TabItem value="kde" label="Linux (KDE)">
114-
115-
KDE's documentation covers auto-starting applications well: see [System Settings/Autostart](https://userbase.kde.org/System_Settings/Autostart) from the KDE UsersBase Wiki for more information.
116-
117-
</TabItem>
118-
</Tabs>
119-
120-
</details>
121-
12278
### Add a Connection
12379

124-
![A new connection to an SSH gateway](examples/img/desktop/demo-new-connection.png)
80+
![Adding a new connection in the Pomerium Desktop client](./examples/img/desktop/desktop-new-connection.png)
12581

126-
**Name**: A local name for the route.
82+
**Name**: A local name for the route
12783

12884
**Destination**: Matches the [From](/docs/reference/routes/from) value of the route, without the protocol. Always include the port specified in the route, and do not include the `https://` protocol.
12985

13086
**Local Address**: The local address and port number from which to access the service locally. If left blank, the client will choose a random port to listen to on the loopback address.
13187

132-
In most cases, you only need to specify the port (ex: `:2222`), and the client will listen on all available local addresses.
133-
134-
**Tags**: Use tags to sort and organize your TCP routes.
88+
**Tags**: Customizable tags to sort and organize TCP routes
13589

13690
:::note Long-lived connections behavior
13791

@@ -141,18 +95,20 @@ In most cases, you only need to specify the port (ex: `:2222`), and the client w
14195

14296
---
14397

144-
#### Advanced Settings
98+
### Advanced Settings
99+
100+
![Reviewing the Advanced Settings in the Pomerium Desktop client](./examples/img/desktop/desktop-advanced-settings.png)
145101

146102
**Pomerium URL**: The Pomerium Proxy service address. This is required if the **Destination URL** can't be resolved from DNS or a local `hosts` entry, or if the Proxy service uses a non-standard port.
147103

148104
**Disable TLS Verification**: Allows untrusted certificates from the Pomerium gateway
149105

150-
**Client Certificate & Certificate Key File or Text**: For routes that require client certificates for [mTLS](/docs/concepts/mutual-auth.md), you can provide the certificate and key file to the Pomerium Desktop client.
106+
**Client Certificates**: The client certificates options allow you to **set client certificates manually** or to [**search the OS certificate store**](/docs/capabilities/tcp#client-certificates) for trusted CA names. Use these options to add client certificates to routes that enforce [mTLS](/docs/concepts/mutual-auth).
151107

152108
</TabItem>
153109
<TabItem value="Pomerium CLI" label="Pomerium CLI">
154110

155-
### Install
111+
### Install Pomerium CLI
156112

157113
See the [Pomerium CLI](/docs/deploy/clients/pomerium-cli) page to learn how to install `pomerium-cli` in your environment.
158114

@@ -189,7 +145,14 @@ See the [Pomerium CLI](/docs/deploy/clients/pomerium-cli) page to learn how to i
189145
</TabItem>
190146
</Tabs>
191147

192-
For more examples and detailed usage information, see [TCP Support](/docs/capabilities/tcp)
148+
:::info
149+
150+
For more examples and detailed usage information, see the following docs:
151+
152+
- [**TCP Reference**](/docs/capabilities/tcp/reference)
153+
- [**Securing TCP-based Services**](/docs/guides/docs/guides/securing-tcp)
154+
155+
:::
193156

194157
## Advanced Configuration
195158

Binary file not shown.
Loading
Loading
Loading

0 commit comments

Comments
 (0)