Skip to content

Commit d8d88b6

Browse files
committed
add routes portal capability
1 parent 064d3e3 commit d8d88b6

File tree

4 files changed

+50
-0
lines changed

4 files changed

+50
-0
lines changed
Loading
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Pomerium Routes Portal
3+
lang: en-US
4+
sidebar_label: 'Routes Portal'
5+
description: How to quickly view the routes you have access to in Pomerium.
6+
keywords: [pomerium, routing, portal]
7+
---
8+
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.
10+
11+
![Routes Portal](./img/routes-portal/routes-portal.png)
12+
13+
This data is also available as JSON at `/.pomerium/api/v1/routes`.
14+
15+
```json
16+
{
17+
"routes": [
18+
{
19+
"id": "c7cc6f3995e8c6e4",
20+
"name": "postgres",
21+
"type": "tcp",
22+
"from": "tcp+https://postgres.curious-cat-9999.pomerium.app:5432",
23+
"description": "",
24+
"connect_command": "pomerium-cli tcp postgres.curious-cat-9999.pomerium.app:5432"
25+
},
26+
{
27+
"id": "2116ef165e888f1a",
28+
"name": "verify",
29+
"type": "http",
30+
"from": "https://verify.curious-cat-9999.pomerium.app",
31+
"description": ""
32+
}
33+
]
34+
}
35+
```
36+
37+
### CLI
38+
39+
The Pomerium CLI can list routes via the `routes list` subcommand:
40+
41+
```bash
42+
pomerium-cli routes list https://curious-cat-9999.pomerium.app
43+
```
44+
45+
### Desktop Client
46+
47+
The Pomerium Desktop Client can automatically create connections using the Routes Portal.
48+
49+
![Desktop Client](./img/routes-portal/desktop-client.png)

sidebars.js

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ const sidebars = {
4343
'docs/capabilities/authorization',
4444
'docs/capabilities/getting-users-identity',
4545
'docs/capabilities/routing',
46+
'docs/capabilities/routes-portal',
4647
'docs/capabilities/custom-domains',
4748
// secondary capabilities
4849
{

0 commit comments

Comments
 (0)