Skip to content

Commit b2fbf3a

Browse files
authored
Manual backport: 1152 to v0.22 (#1166)
* resolves conflicts * fixes broken links * adds tabs * runs prettier * re-runs prettier * runs prettier * fixes formatting * runs prettier * fixes prettier failures
1 parent 9805835 commit b2fbf3a

22 files changed

+61
-52
lines changed

content/docs/capabilities/authorization.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
# cSpell:ignore abac gset
2+
# cSpell:ignore abac, gset, nxon
33

44
title: Authorization & Policy
55
lang: en-US
@@ -93,9 +93,9 @@ In this example, only a user with the email `[email protected]` can access the ta
9393

9494
In the Enterprise Console, you can use the **EDITOR** to manually configure policy with PPL:
9595

96-
![Build policy with PPL in Console](./img/authorization/ppl-editor-policy.png)
96+
![Build an authorization policy with PPL in the Enterprise Console](./img/authorization/ppl-edit-policy.png)
9797

98-
In this example, a user will have access if their email address ends in `example.com` and they are a member of the `admin` group. The user will be denied access on Saturdays and Sundays.
98+
In this example, Pomerium will grant a user access if their email address ends in `example.com` and their `groups` ID matches `00gso9nxonHI4YfbM4x6`. Pomerium will deny the user access on Saturdays and Sundays.
9999

100100
</TabItem>
101101
</Tabs>

content/docs/capabilities/device-identity.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ keywords:
1818

1919
import ManageDevices from '../reference/_manage-devices.md';
2020
import NewEnrollment from '../reference/_new-enrollment.md';
21+
import Tabs from '@theme/Tabs';
22+
import TabItem from '@theme/TabItem';
2123

2224
Device identity is the unique ID associated with a device. In the context of zero trust, device identity can be used to authenticate and authorize users and to determine if a device can be trusted before granting a user access to a protected application or service.
2325

Loading
Binary file not shown.

content/docs/capabilities/mtls-services.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ OpenSSL is installed or easily available for most 'nix-based operating systems l
138138
139139
Pomerium should automatically process changes when the configuration file is updated.
140140
141-
1. Visit <https://openssl.localhost.pomerium.io> in your browser to confirm the route:
141+
1. Visit [https://openssl.localhost.pomerium.io](https://openssl.localhost.pomerium.io) in your browser to confirm the route:
142142
143143
![OpenSSL Upstream without client certificate verification](./img/mtls/openssl-test1.png)
144144
@@ -156,7 +156,7 @@ OpenSSL is installed or easily available for most 'nix-based operating systems l
156156
openssl s_server -Verify 1 -key ./openssl.localhost-key.pem -cert ./openssl.localhost.pem -accept 44330 -www
157157
```
158158

159-
1. When you refresh <https://openssl.localhost.pomium.io> in your browser, the connection will fail. Back in the terminal, the OpenSSL server should output errors containing:
159+
1. When you refresh [https://openssl.localhost.pomium.io](https://openssl.localhost.pomium.i) in your browser, the connection will fail. Back in the terminal, the OpenSSL server should output errors containing:
160160

161161
```log
162162
SSL routines:tls_process_client_certificate:peer did not return a certificate
@@ -179,7 +179,7 @@ OpenSSL is installed or easily available for most 'nix-based operating systems l
179179
180180
```
181181

182-
Now when you visit <https://openssl.localhost.pomium.io> you should see additional output under **Client certificate**, confirming that the upstream service has read and validated Pomerium's client certificate. Your upstream service is now using mTLS for mutual authentication!
182+
Now when you visit [https://openssl.localhost.pomium.io](https://openssl.localhost.pomium.io) you should see additional output under **Client certificate**, confirming that the upstream service has read and validated Pomerium's client certificate. Your upstream service is now using mTLS for mutual authentication!
183183

184184
Obviously, the OpenSSL server is a trivial upstream service, and is purpose-built to work with encryption and not much else. Practical mutual authenticate can be a much more complex setup depending on the service, and may require a sidecar or service mesh. This exercise merely serves to demonstrate how easy it is to configure Pomerium to provide client certificates to the upstream service.
185185

content/docs/capabilities/programmatic-access.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ To learn more about JWTs and identity verification, see the following docs:
6161

6262
### Alternative to Login API for `localhost` development
6363

64-
Alternatively you can create a new policy to route an endpoint to a [bastion host](https://en.wikipedia.org/wiki/Bastion_host). You should include a HTTP proxy on this bastion host for HTTPS traffic. Here's one way to do it with nginx: <https://jerrington.me/posts/2019-01-29-self-hosted-ngrok.html> An HTTP proxy on the bastion allows us to receive HTTPS traffic with a self signed cert through LetsEncrypt.
64+
Alternatively you can create a new policy to route an endpoint to a [bastion host](https://en.wikipedia.org/wiki/Bastion_host). You should include a HTTP proxy on this bastion host for HTTPS traffic. Here's one way to do it with nginx: [https://jerrington.me/posts/2019-01-29-self-hosted-ngrok.html](https://jerrington.me/posts/2019-01-29-self-hosted-ngrok.html) An HTTP proxy on the bastion allows us to receive HTTPS traffic with a self signed cert through LetsEncrypt.
6565

6666
This alternative will allow you to act as if your service is deployed and fronted by Pomerium. We will then forward the remote port from the bastion host behind the pomerium-proxy to localhost.
6767

content/docs/capabilities/routing.mdx

+5-7
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,11 @@ When first installing Pomerium Enterprise, users may want to import existing rou
3030

3131
From the main Routes page you can view and manage existing routes. From the table of routes you can:
3232

33-
- filter visible routes,
34-
- delete one or more routes,
35-
- move routes between Namespaces,
36-
- export one or more route definitions to a CSV file
37-
38-
39-
- create a JSON-formatted policy report on one or more selected routes.
33+
- Filter visible routes
34+
- Delete one or more routes
35+
- Move routes between Namespaces
36+
- Export one or more route definitions to a CSV file
37+
- Create a JSON-formatted policy report on one or more selected routes
4038

4139
The sections below cover the options available when creating or editing a route.
4240

content/docs/community/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Here are some of the expectations we have of contributors:
4343

4444
## Docs
4545

46-
Pomerium's documentation is available at <https://www.pomerium.io/docs>. If you find a typo, feel a section could be better described, or have an idea for a totally new application or section, don't hesitate to make a pull request change. There are few ways you can do this.
46+
Pomerium's documentation is available at [https://www.pomerium.io/docs](https://www.pomerium.io/docs). If you find a typo, feel a section could be better described, or have an idea for a totally new application or section, don't hesitate to make a pull request change. There are few ways you can do this.
4747

4848
### Simple edits
4949

content/docs/concepts/device-identity.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Hardware-backed device identity is becoming more widely discussed as more produc
2626

2727
| ![Verge Article Header and Apple Video Page](./img/verge-apple.png) |
2828
| :-- |
29-
| **Sources:**<br />- <https://www.theverge.com/2021/6/25/22550376/microsoft-windows-11-tpm-chips-requirement-security><br/>- <https://developer.apple.com/videos/play/wwdc2021/10106/> |
29+
| **Sources:**<br />- [https://www.theverge.com/2021/6/25/22550376/microsoft-windows-11-tpm-chips-requirement-security](https://www.theverge.com/2021/6/25/22550376/microsoft-windows-11-tpm-chips-requirement-security)<br/>- [https://developer.apple.com/videos/play/wwdc2021/10106](https://developer.apple.com/videos/play/wwdc2021/10106) |
3030

3131
Device identity protects a trusted user from accessing sensitive data from a potentially unsafe device, like their personal computer or phone. Think of it as similar to multi-factor authentication (**MFA**); where MFA covers "what you know" (password) and "who you are" (biometrics, face recognition, etc), device identity asks "is this device safe?" by confirming that the device you are using to access a system is trusted.
3232

content/docs/deploy/clients/pomerium-cli.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ sidebar_label: Pomerium-CLI (Client)
2020
sidebar_position: 3
2121
---
2222

23+
import Tabs from '@theme/Tabs';
24+
import TabItem from '@theme/TabItem';
25+
2326
# Pomerium's Command Line Interface
2427

2528
`pomerium-cli` (optional, Pomerium is clientless for HTTP based protocols) is a command-line client for working with Pomerium. Functions include acting as an authentication helper for tools like [kubectl](/docs/deploy/k8s/configure.md) or TCP [based applications](/docs/capabilities/tcp/).

content/docs/deploy/core.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ We recommend following the steps in the Kubernetes [Installation](/docs/deploy/k
122122

123123
:::
124124

125-
Pomerium maintains a [helm](https://helm.sh) chart for easy Kubernetes deployment with best practices <https://helm.pomerium.io/>
125+
Pomerium maintains a [helm](https://helm.sh) chart for easy Kubernetes deployment with best practices [https://helm.pomerium.io/](https://helm.pomerium.io/)
126126

127127
```bash
128128
helm repo add pomerium https://helm.pomerium.io

content/docs/deploy/core/changelog.mdx

+10-10
Original file line numberDiff line numberDiff line change
@@ -904,16 +904,16 @@ Please refer to the [upgrade guide](/docs/deploy/core/upgrading) before upgradin
904904

905905
### Changes
906906

907-
- authenticate: fix internal service URL CORS check by @calebdoxsey in <https://github.com/pomerium/pomerium/pull/3328>
908-
- authenticate: fix internal service URL dashboard redirect by @calebdoxsey in <https://github.com/pomerium/pomerium/pull/3306>
909-
- DOCS: Add device identity video <https://github.com/pomerium/pomerium/pull/3307>
910-
- DOCS: Update changelog <https://github.com/pomerium/pomerium/pull/3308>
911-
- DOCS: update helm values file <https://github.com/pomerium/pomerium/pull/3287>
912-
- fix: close the ticker after opened by @clwluvw <https://github.com/pomerium/pomerium/pull/3323>
913-
- httputil/reproxy: fix policy transport by @calebdoxsey <https://github.com/pomerium/pomerium/pull/3324>
914-
- Update docs for supported Ingress annotations <https://github.com/pomerium/pomerium/pull/3325>
915-
916-
**Full Changelog**: <https://github.com/pomerium/pomerium/compare/v0.17.2...v0.17.3>
907+
- authenticate: fix internal service URL CORS check by @calebdoxsey in [https://github.com/pomerium/pomerium/pull/3328](https://github.com/pomerium/pomerium/pull/3328)
908+
- authenticate: fix internal service URL dashboard redirect by @calebdoxsey in [https://github.com/pomerium/pomerium/pull/3306](https://github.com/pomerium/pomerium/pull/3306)
909+
- DOCS: Add device identity video [https://github.com/pomerium/pomerium/pull/3307](https://github.com/pomerium/pomerium/pull/3307)
910+
- DOCS: Update changelog [https://github.com/pomerium/pomerium/pull/3308](https://github.com/pomerium/pomerium/pull/3308)
911+
- DOCS: update helm values file [https://github.com/pomerium/pomerium/pull/3287](https://github.com/pomerium/pomerium/pull/3287)
912+
- fix: close the ticker after opened by @clwluvw [https://github.com/pomerium/pomerium/pull/3323](https://github.com/pomerium/pomerium/pull/3323)
913+
- httputil/reproxy: fix policy transport by @calebdoxsey [https://github.com/pomerium/pomerium/pull/3324](https://github.com/pomerium/pomerium/pull/3324)
914+
- Update docs for supported Ingress annotations [https://github.com/pomerium/pomerium/pull/3325](https://github.com/pomerium/pomerium/pull/3325)
915+
916+
**Full Changelog**: [https://github.com/pomerium/pomerium/compare/v0.17.2...v0.17.3](https://github.com/pomerium/pomerium/compare/v0.17.2...v0.17.3)
917917

918918
## [v0.17.2](https://github.com/pomerium/pomerium/tree/v0.17.2) (2022-04-22)
919919

content/docs/deploy/core/upgrading.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ To improve performance, IdP directory synchronization for GitHub now uses the Gr
172172

173173
#### CLI Source and Packaging Update
174174

175-
`pomerium-cli` has been factored out of the core repository and now resides at <https://github.com/pomerium/cli>. If you currently install the CLI tool from [Packages](/docs/deploy/core#packages-2) or [Homebrew](/docs/deploy/core#homebrew), no changes should be required to your process. However, users of docker images or direct github release downloads will need to update their references.
175+
`pomerium-cli` has been factored out of the core repository and now resides at [https://github.com/pomerium/cli](https://github.com/pomerium/cli). If you currently install the CLI tool from [Packages](/docs/deploy/core#packages-2) or [Homebrew](/docs/deploy/core#homebrew), no changes should be required to your process. However, users of docker images or direct github release downloads will need to update their references.
176176

177177
Please see the [updated install instructions](/docs/deploy/clients/pomerium-cli) for additional details.
178178

content/docs/guides/argo.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ You should now have a working Argo installation using [Minio](https://min.io/) t
3333
kubectl --namespace kube-system port-forward svc/argo-minio 9000:9000
3434
```
3535

36-
You should now be able to reach the Minio UI by accessing <http://localhost:9000/minio>. If you're curious the Access Key and Secret Key are generated by the Helm chart and stored in a Kubernetes secret:
36+
You should now be able to reach the Minio UI by accessing [http://localhost:9000/minio](http://localhost:9000/minio). If you're curious the Access Key and Secret Key are generated by the Helm chart and stored in a Kubernetes secret:
3737

3838
```bash
3939
kubectl --namespace=kube-system get secret argo-minio -o yaml
@@ -45,7 +45,7 @@ For now though, let's terminate the Minio `kubectl port-forward` and create one
4545
kubectl --namespace kube-system port-forward svc/argo-server 2746:2746
4646
```
4747

48-
Visiting <http://localhost:2746> should take you to the Argo Workflows dashboard.
48+
Visiting [http://localhost:2746](http://localhost:2746) should take you to the Argo Workflows dashboard.
4949

5050
## Install NGINX Ingress Controller
5151

@@ -101,4 +101,4 @@ You should now be able to reach argo by using `kubectl port-forward` with the NG
101101
kubectl --namespace kube-system port-forward svc/ingress-nginx-controller 443:443
102102
```
103103

104-
And visit: <https://argo.localhost.pomerium.io/>.
104+
And visit: [https://argo.localhost.pomerium.io](https://argo.localhost.pomerium.io/).

content/docs/guides/cloud-run.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,15 @@ Here are the domain mappings set up:
9797

9898
### Direct Access
9999

100-
Let's verify we cannot access the main application directly by visiting <https://hello-direct.cloudrun.pomerium.io>
100+
Let's verify we cannot access the main application directly by visiting [https://hello-direct.cloudrun.pomerium.io](https://hello-direct.cloudrun.pomerium.io)
101101

102102
![Hello Direct Access](img/cloud-run/hello-direct.png)
103103

104104
You should see a 403 error because you do not have the proper credentials.
105105

106106
### Authenticated Access
107107

108-
Now let's access via <https://hello.cloudrun.pomerium.io>
108+
Now let's access via [https://hello.cloudrun.pomerium.io](https://hello.cloudrun.pomerium.io)
109109

110110
We should get an auth flow through your IdP:
111111

content/docs/guides/helm.mdx

+17-15
Original file line numberDiff line numberDiff line change
@@ -163,31 +163,33 @@ If you haven't already, install cert-manager and create a CA issuer. You can fol
163163

164164
1. Create a values file for Helm to use when installing Pomerium. Our example is named `pomerium-values.yaml`.
165165

166-
<PomeriumValues />
166+
<PomeriumValues />
167167

168-
:::tip
168+
:::tip
169169

170-
The options required in the `authenticate.idp` block will vary depending on your [identity provider].
170+
The options required in the `authenticate.idp` block will vary depending on your [identity provider].
171171

172-
If you changed the `*.localhost.pomerium.io` value in `pomerium-certificates.yaml` update `config.rootDomain` to match, omitting the `*`.
172+
If you changed the `*.localhost.pomerium.io` value in `pomerium-certificates.yaml` update `config.rootDomain` to match, omitting the `*`.
173173

174-
:::
174+
:::
175175

176-
<details><summary>Default Certificate</summary>
176+
<details>
177177

178-
If you're using a single wildcard certificate for all routes managed by Pomerium, you can set it in an annotation for the ingress controller.
178+
<summary>Default Certificate</summary>
179179

180-
Add a block defining the default certificate to `pomerium-values.yaml`:
180+
If you're using a single wildcard certificate for all routes managed by Pomerium, you can set it in an annotation for the ingress controller.
181181

182-
```yaml
183-
ingressController:
184-
ingressClassResource:
185-
defaultCertSecret: 'namespace/certSecretName'
186-
```
182+
Add a block defining the default certificate to `pomerium-values.yaml`:
183+
184+
```yaml
185+
ingressController:
186+
ingressClassResource:
187+
defaultCertSecret: 'namespace/certSecretName'
188+
```
187189
188-
Now when defining ingresses you need not specify individual certificates, as documented in our example service below.
190+
Now when defining ingresses you need not specify individual certificates, as documented in our example service below.
189191
190-
</details>
192+
</details>
191193
192194
1. Add Pomerium's Helm repo:
193195

content/docs/guides/synology.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Using Pomerium on your Synology DSM device enables:
1515
- Access to services by sub-domain (e.g. `plex.int.nas.example` or `wiki.int.nas.example`)
1616
- TLS everywhere.
1717

18-
Pomerium is lightweight, can easily handle hundreds of concurrent requests, and a single instance typically uses <20MB of memory and very little CPU.
18+
Pomerium is lightweight, can easily handle hundreds of concurrent requests, and a single instance typically uses less than 20MB of memory and very little CPU.
1919

2020
## Prerequisites
2121

content/docs/identity-providers/azure.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ While we do our best to keep our documentation up to date, changes to third-part
1919

2020
If you plan on allowing users to log in using a Microsoft Azure Active Directory account, either from your company or from external directories, you must register your application through the Microsoft Azure portal. If you don't have a Microsoft Azure account, you can [sign up](https://azure.microsoft.com/en-us/free) for free.
2121

22-
You can access the Azure management portal from your Microsoft service, or visit <https://portal.azure.com> and sign in to Azure using the global administrator account used to create the Office 365 organization.
22+
You can access the Azure management portal from your Microsoft service, or visit [https://portal.azure.com](https://portal.azure.com) and sign in to Azure using the global administrator account used to create the Office 365 organization.
2323

2424
:::tip
2525

content/docs/identity-providers/cognito.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ If you need to make changes after creating your pool, be aware that some setting
7575
| **Field** | **Description** |
7676
| --- | --- |
7777
| Enabled Identity Providers | Choose **Cognito User Pool**, unless you have set up another **Identity Provider** (eg SAML) |
78-
| Callback URL(s) | https://${authenticate_service_url}/oauth2/callback |
78+
| Callback URL(s) | https://{AUTHENTICATE_SERVICE_URL}/oauth2/callback |
7979
| Allowed OAuth Flows | Authorization code grant |
8080
| Allowed OAuth Scopes | Email, OpenID, Profile |
8181

content/docs/internals/security.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ While researching, we'd like you to refrain from:
7272
- Social engineering or phishing of Pomerium employees or contractors
7373
- Any attacks against Pomerium's physical property or data centers
7474

75-
We may revise these guidelines from time to time. The most current version of the guidelines will be available at <https://pomerium.com/docs/community/security>.
75+
We may revise these guidelines from time to time. The most current version of the guidelines will be available at [https://pomerium.com/docs/community/security](https://pomerium.com/docs/community/security).
7676

7777
Though we accept PGP-encrypted email, please only use it for critical security reports.
7878

content/docs/reference/routes/timeouts.mdx

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ description: Configure Timeouts settings in Pomerium.
55
keywords: [websocket connections, spdy, route timeout, route idle timeout]
66
---
77

8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
10+
811
# Timeouts Settings
912

1013
This reference covers all of Pomerium's **Timeouts Settings**:

src/components/Newsletter.js

+1
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ const CustomFormFooter = ({status, message, onValidated}) => {
8181
height: 48,
8282
border: 'none',
8383
borderRadius: '25px',
84+
cursor: 'pointer',
8485
}}
8586
className="top-0 right-0 bottom-0 w-12 flex hover:text-purple"
8687
onClick={submit}>

0 commit comments

Comments
 (0)