ENG-1873: Add narrative and FAQ to Routes Portal #1799
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
rjbeers
commented
Mar 6, 2025
rjbeers
force-pushed
the
rjbeers/eng-1873-document-routes-portal-functionality
branch
from
5196572 to
82b392f
Compare
calebdoxsey
reviewed
Mar 7, 2025
| 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. |
There was a problem hiding this comment.
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. |
calebdoxsey
reviewed
Mar 7, 2025
| This data is also available as JSON at `/.pomerium/api/v1/routes`. | ||
| ### 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. |
There was a problem hiding this comment.
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. |
calebdoxsey
reviewed
Mar 7, 2025
| - [**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. ::: |
There was a problem hiding this comment.
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. | |
| ::: |
calebdoxsey
reviewed
Mar 7, 2025
|
|
||
| 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. | ||
|
|
||
| :::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. ::: |
There was a problem hiding this comment.
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. | |
| ::: |
calebdoxsey
approved these changes
Mar 7, 2025
|
Good catches! Odd that our formatted messed up the notes, but not all of them. |
rjbeers
deleted the
rjbeers/eng-1873-document-routes-portal-functionality
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a bit more context to the Routes Portal feature along with FAQs for topics that have come up.