Skip to content

Commit

Permalink
add routes portal capability (#1769)
Browse files Browse the repository at this point in the history
  • Loading branch information
calebdoxsey authored Feb 6, 2025
1 parent ab3e1dd commit 7c16459
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 0 deletions.
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.
49 changes: 49 additions & 0 deletions content/docs/capabilities/routes-portal.mdx
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)
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ const sidebars = {
'docs/capabilities/authorization',
'docs/capabilities/getting-users-identity',
'docs/capabilities/routing',
'docs/capabilities/routes-portal',
'docs/capabilities/custom-domains',
// secondary capabilities
{
Expand Down

0 comments on commit 7c16459

Please sign in to comment.