Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENG-1873: Add narrative and FAQ to Routes Portal #1799

Merged
merged 5 commits into from
Mar 7, 2025
Merged

ENG-1873: Add narrative and FAQ to Routes Portal #1799

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
90b06b1
ENG-1873: Add narrative and FAQ to Routes Portal
rjbeers Mar 6, 2025
82b392f
typo
rjbeers Mar 7, 2025
7258a00
prettier
rjbeers Mar 7, 2025
e1d620e
fix prettier even though this might get removed
rjbeers Mar 7, 2025
6af30f2
pr feedback
rjbeers Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 18 additions & 32 deletions content/docs/capabilities/routes-portal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,45 +6,32 @@ description: How to quickly view the routes you have access to in Pomerium.
keywords: [pomerium, routes, portal, cli, desktop client, JSON API]
---

The Pomerium Routes Portal allows a user to see all the routes they have access to and easily navigate or connect to them.
The Routes Portal is personalized for each user based their authorization to the configured routes.
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.
The Pomerium Routes Portal allows a user to see all the routes they have access to and easily navigate or connect to them. The Routes Portal is personalized for each user based their authorization to the configured routes. 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Pomerium Routes Portal allows a user to see all the routes they have access to and easily navigate or connect to them. The Routes Portal is personalized for each user based their authorization to the configured routes. 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.
The Pomerium Routes Portal allows a user to see all the routes they have access to and easily navigate or connect to them. The Routes Portal is personalized for each user based on their authorization to the configured routes. 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.


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.

## Ways of Accessing the Routes Portal

The Routes Portal is available in the following ways:
* [**Web Page**](#web-page) - Generally useful for quickly navigating to available web applications or identifying non-HTTP CLI commands
* [**Desktop Client**](#desktop-client) - Best for setting up non-HTTP connections such as SSH or databases
* [**CLI**](#cli) - Can be used programmatically to list routes and then connect to them
* [**JSON API**](#json-api) - Can be used to integrate with your own systems and processes

:::note Identifying Your Pomerium Domain
The Routes Portal is available on all Pomerium cluster domains.
New users should contact their Pomerium administrator to identify their organization's Pomerium domain.
The domain could be a Pomerium provided domain such as `curious-cat-9999.pomerium.app` or a custom domain.
:::
- [**Web Page**](#web-page) - Generally useful for quickly navigating to available web applications or identifying non-HTTP CLI commands
- [**Desktop Client**](#desktop-client) - Best for setting up non-HTTP connections such as SSH or databases
- [**CLI**](#cli) - Can be used programmatically to list routes and then connect to them
- [**JSON API**](#json-api) - Can be used to integrate with your own systems and processes

:::note Identifying Your Pomerium Domain The Routes Portal is available on all Pomerium cluster domains. New users should contact their Pomerium administrator to identify their organization's Pomerium domain. The domain could be a Pomerium provided domain such as `curious-cat-9999.pomerium.app` or a custom domain. :::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:::note Identifying Your Pomerium Domain The Routes Portal is available on all Pomerium cluster domains. New users should contact their Pomerium administrator to identify their organization's Pomerium domain. The domain could be a Pomerium provided domain such as `curious-cat-9999.pomerium.app` or a custom domain. :::
:::note Identifying Your Pomerium Domain
The Routes Portal is available on all Pomerium cluster domains. New users should contact their Pomerium administrator to identify their organization's Pomerium domain. The domain could be a Pomerium provided domain such as `curious-cat-9999.pomerium.app` or a custom domain.
:::


### Web Page

The web page version of the Routes Portal is accessible via a web browser at `https://<your-pomerium-domain>/.pomerium/routes`.
Accessing the page when not authenticated will redirect you to the configured Identity Provider for authentication.
Once logged in, you will see a list of all the routes you have access to.
The web page version of the Routes Portal is accessible via a web browser at `https://<your-pomerium-domain>/.pomerium/routes`. Accessing the page when not authenticated will redirect you to the configured Identity Provider for authentication. Once logged in, you will see a list of all the routes you have access to.

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

### Desktop Client

The Pomerium Desktop Client can automatically create connections using the Routes Portal.
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.
After providing your Pomerium cluster domain, the Desktop Client will automatically load all the routes you have access to.
You may optionally specific a tag for the loaded routes to identify the ones created by this process.
The Pomerium Desktop Client can automatically create connections using the Routes Portal. 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. After providing your Pomerium cluster domain, the Desktop Client will automatically load all the routes you have access to. You may optionally specific a tag for the loaded routes to identify the ones created by this process.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Pomerium Desktop Client can automatically create connections using the Routes Portal. 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. After providing your Pomerium cluster domain, the Desktop Client will automatically load all the routes you have access to. You may optionally specific a tag for the loaded routes to identify the ones created by this process.
The Pomerium Desktop Client can automatically create connections using the Routes Portal. 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. After providing your Pomerium cluster domain, the Desktop Client will automatically load all the routes you have access to. You may optionally specify a tag for the loaded routes to identify the ones created by this process.


:::note Updating Routes in the Desktop Client
The Desktop Client does not automatically update the routes list when changes are made to the Pomerium configuration.
An updated routes list can be loaded by performing the same process again.
:::
:::note Updating Routes in the Desktop Client The Desktop Client does not automatically update the routes list when changes are made to the Pomerium configuration. An updated routes list can be loaded by performing the same process again. :::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:::note Updating Routes in the Desktop Client The Desktop Client does not automatically update the routes list when changes are made to the Pomerium configuration. An updated routes list can be loaded by performing the same process again. :::
:::note Updating Routes in the Desktop Client
The Desktop Client does not automatically update the routes list when changes are made to the Pomerium configuration. An updated routes list can be loaded by performing the same process again.
:::


![Desktop Client](./img/routes-portal/desktop-client.png)

Expand Down Expand Up @@ -82,23 +69,22 @@ Accessible via a JSON API at `https://<your-pomerium-domain>/.pomerium/api/v1/ro
}
```


## FAQ

### Is the Routes Portal publicly available?
Yes, the Routes Portal is publicly available, but only authenticated users will be able to see the routes they have access to.
Unauthenticated users will be forced to authenticate.

Yes, the Routes Portal is publicly available, but only authenticated users will be able to see the routes they have access to. Unauthenticated users will be forced to authenticate.

### Can I disable the Routes Portal?

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].

### Can I customize the Routes Portal?
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.
If you are interested in further customization, please contact [email protected]

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. If you are interested in further customization, please contact [email protected]

### How can I find my Routes Portal domain?
The Routes Portal is available on all Pomerium cluster domains.
If you know the URL of one of your routes, the domain of this route is your Pomerium domain.

New users should contact their Pomerium administrator to identify their organization's Pomerium domain.
The domain could be a Pomerium provided domain such as curious-cat-9999.pomerium.app or a custom domain configured by an administrator.
The Routes Portal is available on all Pomerium cluster domains. If you know the URL of one of your routes, the domain of this route is your Pomerium domain.

New users should contact their Pomerium administrator to identify their organization's Pomerium domain. The domain could be a Pomerium provided domain such as curious-cat-9999.pomerium.app or a custom domain configured by an administrator.