Skip to content

Commit 5196572

Browse files
committed
ENG-1873: Add narrative and FAQ to Routes Portal
1 parent 1c9eb2f commit 5196572

File tree

1 file changed

+66
-11
lines changed

1 file changed

+66
-11
lines changed

content/docs/capabilities/routes-portal.mdx

+66-11
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,62 @@ title: Pomerium Routes Portal
33
lang: en-US
44
sidebar_label: 'Routes Portal'
55
description: How to quickly view the routes you have access to in Pomerium.
6-
keywords: [pomerium, routing, portal]
6+
keywords: [pomerium, routes, portal, cli, desktop client, JSON API]
77
---
88

9-
The Pomerium Routes Portal allows a user to see all the routes they have access to. It is available on any domain frontend by Pomerium at the special `/.pomerium/routes` endpoint.
9+
The Pomerium Routes Portal allows a user to see all the routes they have access to and easily navigate or connect to them.
10+
The Routes Portal is personalized for each user based their authorization to the configured routes.
11+
For non-HTTP routes, such as SSH or plain TCP connections, the portal provides corresponding Pomerium CLI commands that can be used to connect to the resources.
12+
13+
We recommend using the Routes Portal to help onboard new users to Pomerium and to provide a central location for users to access all their resources.
14+
15+
## Ways of Accessing the Routes Portal
16+
17+
The Routes Portal is available in the following ways:
18+
* [**Web Page**](#web-page) - Generally useful for quickly navigating to available web applications or identifying non-HTTP CLI commands
19+
* [**Desktop Client**](#desktop-client) - Best for setting up non-HTTP connections such as SSH or databases
20+
* [**CLI**](#cli) - Can be used programmatically to list routes and then connect to them
21+
* [**JSON API**](#json-api) - Can be used to integrate with your own systems and processes
22+
23+
:::note Identifying Your Pomerium Domain
24+
The Routes Portal is available on all Pomerium cluster domains.
25+
New users should contact their Pomerium administrator to identify their organization's Pomerium domain.
26+
The domain could be a Pomerium provided domain such as `curious-cat-9999.pomerium.app` or a custom domain.
27+
:::
28+
29+
### Web Page
30+
31+
The web page version of the Routes Portal is accessible via a web browser at `https://<your-pomerium-domain>/.pomerium/routes`.
32+
Accessing the page when not authenticated will redirect you to the configured Identity Provider for authentication.
33+
Once logged in, you will see a list of all the routes you have access to.
1034

1135
![Routes Portal](./img/routes-portal/routes-portal.png)
1236

13-
This data is also available as JSON at `/.pomerium/api/v1/routes`.
37+
### Desktop Client
38+
39+
The Pomerium Desktop Client can automatically create connections using the Routes Portal.
40+
While static route lists can be exported, shared, and imported by users looking to set up their Pomerium Desktop Client, the portal provides a more dynamic way of loading available route configuration.
41+
After providing your Pomerium cluster domain, the Desktop Client will automatically load all the routes you have access to.
42+
You may optionally specific a tag for the loaded routes to identify the ones created by this process.
43+
44+
:::note Updating Routes in the Desktop Client
45+
The Desktop Client does not automatically update the routes list when changes are made to the Pomerium configuration.
46+
An updated routes list can be loaded by performing the same process again.
47+
:::
48+
49+
![Desktop Client](./img/routes-portal/desktop-client.png)
50+
51+
### CLI
52+
53+
The Pomerium CLI can list routes via the `routes list` subcommand:
54+
55+
```bash
56+
pomerium-cli routes list https://<your-pomerium-domain>
57+
```
58+
59+
### JSON API
60+
61+
Accessible via a JSON API at `https://<your-pomerium-domain>/.pomerium/api/v1/routes`
1462

1563
```json
1664
{
@@ -34,16 +82,23 @@ This data is also available as JSON at `/.pomerium/api/v1/routes`.
3482
}
3583
```
3684

37-
### CLI
3885

39-
The Pomerium CLI can list routes via the `routes list` subcommand:
86+
## FAQ
4087

41-
```bash
42-
pomerium-cli routes list https://curious-cat-9999.pomerium.app
43-
```
88+
### Is the Routes Portal publicly available?
89+
Yes, the Routes Portal is publicly available, but only authenticated users will be able to see the routes they have access to.
90+
Unauthenticated users will be forced to authenticate.
4491

45-
### Desktop Client
92+
### Can I disable the Routes Portal?
93+
No, the Routes Portal is a core feature of Pomerium and cannot be disabled. If you have concerns about the security of the portal, please contact [email protected].
4694

47-
The Pomerium Desktop Client can automatically create connections using the Routes Portal.
95+
### Can I customize the Routes Portal?
96+
The routes which are displayed in the Routes Portal are based on the user's authorization and can be controlled by modifying the applied Pomerium policies for each given route.
97+
If you are interested in further customization, please contact [email protected]
4898

49-
![Desktop Client](./img/routes-portal/desktop-client.png)
99+
### How can I find my Routes Portal Domain?
100+
The Routes Portal is available on all Pomerium cluster domains.
101+
If you know the URL of one of your routes, the domain of this route is your Pomerium domain.
102+
103+
New users should contact their Pomerium administrator to identify their organization's Pomerium domain.
104+
The domain could be a Pomerium provided domain such as curious-cat-9999.pomerium.app or a custom domain configured by an administrator.

0 commit comments

Comments
 (0)