-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add routes portal capability (#1769)
- Loading branch information
1 parent
ab3e1dd
commit 7c16459
Showing
4 changed files
with
50 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
title: Pomerium Routes Portal | ||
lang: en-US | ||
sidebar_label: 'Routes Portal' | ||
description: How to quickly view the routes you have access to in Pomerium. | ||
keywords: [pomerium, routing, portal] | ||
--- | ||
|
||
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. | ||
|
||
![Routes Portal](./img/routes-portal/routes-portal.png) | ||
|
||
This data is also available as JSON at `/.pomerium/api/v1/routes`. | ||
|
||
```json | ||
{ | ||
"routes": [ | ||
{ | ||
"id": "c7cc6f3995e8c6e4", | ||
"name": "postgres", | ||
"type": "tcp", | ||
"from": "tcp+https://postgres.curious-cat-9999.pomerium.app:5432", | ||
"description": "", | ||
"connect_command": "pomerium-cli tcp postgres.curious-cat-9999.pomerium.app:5432" | ||
}, | ||
{ | ||
"id": "2116ef165e888f1a", | ||
"name": "verify", | ||
"type": "http", | ||
"from": "https://verify.curious-cat-9999.pomerium.app", | ||
"description": "" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
### CLI | ||
|
||
The Pomerium CLI can list routes via the `routes list` subcommand: | ||
|
||
```bash | ||
pomerium-cli routes list https://curious-cat-9999.pomerium.app | ||
``` | ||
|
||
### Desktop Client | ||
|
||
The Pomerium Desktop Client can automatically create connections using the Routes Portal. | ||
|
||
![Desktop Client](./img/routes-portal/desktop-client.png) |
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