Skip to content

Commit d26b02c

Browse files
committed
fixes breaking links
1 parent 78b0331 commit d26b02c

File tree

12 files changed

+16
-16
lines changed

12 files changed

+16
-16
lines changed

content/docs/capabilities/getting-users-identity.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -167,5 +167,5 @@ In an actual client, you'll want to ensure that all the other claims values are
167167
[key management service]: https://en.wikipedia.org/wiki/Key_management
168168
[nist p-256]: https://csrc.nist.gov/csrc/media/events/workshop-on-elliptic-curve-cryptography-standards/documents/papers/session6-adalier-mehmet.pdf
169169
[pass identity headers]: /docs/reference/routes/pass-identity-headers-per-route
170-
[signing key]: /docs/reference/signing-key-settings#signing-key
171-
[signing key file]: /docs/reference/signing-key-settings#signing-key-file
170+
[signing key]: /docs/reference/signing-key#signing-key
171+
[signing key file]: /docs/reference/signing-key#signing-key-file

content/docs/core/quickstart.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Although identity verification failed, you successfully integrated Pomerium with
7171

7272
:::tip
7373

74-
Because this guide doesn't include a [signing key](/docs/reference/signing-key-settings#signing-key) in the configuration, identity verification will fail.
74+
Because this guide doesn't include a [signing key](/docs/reference/signing-key#signing-key) in the configuration, identity verification will fail.
7575

7676
See [Identity Verification](/docs/capabilities/getting-users-identity) for more information on how Pomerium can use JWTs for authentication.
7777

content/docs/courses/fundamentals/jwt-verification.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ If that’s a lot to take in, don’t worry, Pomerium handles a lot of it for yo
9797
There are two settings that you need to configure to implement identity verification with signed headers:
9898

9999
- [Pass Identity Headers](/docs/reference/routes/pass-identity-headers-per-route)
100-
- [Signing Key](/docs/reference/signing-key-settings#signing-key)
100+
- [Signing Key](/docs/reference/signing-key#signing-key)
101101

102102
:::info **Global and Route Settings**
103103

content/docs/enterprise/changelog.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ Added support for the Rego [**`print()`**](https://www.openpolicyagent.org/docs/
292292
- Impersonation - Impersonation is now done on an individual session basis.
293293
- Various other bug fixes and improvements.
294294

295-
[`signing key`]: /docs/reference/signing-key-settings#signing-key
295+
[`signing key`]: /docs/reference/signing-key#signing-key
296296
[google cloud serverless]: /docs/reference/routes/enable-google-cloud-serverless-authentication
297297
[policy language]: /docs/capabilities/ppl
298298
[runtime]: /docs/capabilities/reports.md#runtime

content/docs/enterprise/upgrading.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Pomerium Core would only perform user authentication and session refresh with th
140140

141141
### Before You Upgrade
142142

143-
- The [`signing-key`](/docs/reference/signing-key-settings#signing-key) has been replaced with [`authenticate-service-url`](/docs/reference/authenticate-service-url). Instead of manually setting the signing key in the Enterprise Console to match the Authenticate Service, we specify the trusted URL of the Authenticate Service to pull the signing key from.
143+
- The [`signing-key`](/docs/reference/signing-key#signing-key) has been replaced with [`authenticate-service-url`](/docs/reference/authenticate-service-url). Instead of manually setting the signing key in the Enterprise Console to match the Authenticate Service, we specify the trusted URL of the Authenticate Service to pull the signing key from.
144144

145145
The `signing-key` key will continue to work for existing configurations, but [device enrollment](/docs/capabilities/device-identity#new-enrollment-enterprise) will not work until it is replaced by `authenticate-service-url`.
146146

@@ -151,7 +151,7 @@ Pomerium Core would only perform user authentication and session refresh with th
151151
- `signing-key` is now a required option to improve request security from Pomerium Core. The value should match the one set in Pomerium Core. See the [signing key] reference page for more information on generating a key.
152152
- `audience` is now a required option to improve request security from Pomerium Core. The value should match the Enterprise Console's external URL hostname, as defined in the [`from`](/docs/reference/routes) field in the Routes entry (not including the protocol).
153153

154-
[signing key]: /docs/reference/signing-key-settings#signing-key
154+
[signing key]: /docs/reference/signing-key#signing-key
155155

156156
### Helm Installations
157157

content/docs/guides/tooljet.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Next, you need to:
4949
- Replace [email protected] with the email associated with your IdP
5050
- Generate a signing key
5151

52-
To generate a [signing key](/docs/reference/signing-key-settings#signing-key), use the commands below:
52+
To generate a [signing key](/docs/reference/signing-key#signing-key), use the commands below:
5353

5454
```bash
5555
# Generates a P-256 (ES256) signing key
@@ -133,7 +133,7 @@ Next, you need to:
133133
- Replace [email protected] with the email associated with your IdP
134134
- Generate a signing key
135135

136-
To generate a [signing key](/docs/reference/signing-key-settings#signing-key), use the commands below:
136+
To generate a [signing key](/docs/reference/signing-key#signing-key), use the commands below:
137137

138138
```bash
139139
# Generates a P-256 (ES256) signing key

content/docs/identity-providers/oidc.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Note the following points:
179179

180180
:::caution
181181

182-
Do not use the **signing key** in the example above in a production environment. See [**Signing Keys**](/docs/reference/signing-key-settings#signing-key) for more information on generating and using signing keys.
182+
Do not use the **signing key** in the example above in a production environment. See [**Signing Keys**](/docs/reference/signing-key#signing-key) for more information on generating and using signing keys.
183183

184184
:::
185185

content/docs/internals/data-storage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,4 @@ Configuration options for each backend are detailed in the [**databroker configu
9494

9595
## Troubleshooting
9696

97-
Most issues with the Databroker service are caused by a [`shared_secret`](/docs/reference/shared-secret-settings#shared-secret) mismatch between services. See [Troubleshooting - Shared Secret Mismatch](/docs/reference/shared-secret-settings#shared-secret) for details.
97+
Most issues with the Databroker service are caused by a [`shared_secret`](/docs/reference/shared-secret#shared-secret) mismatch between services. See [Troubleshooting - Shared Secret Mismatch](/docs/reference/shared-secret#shared-secret) for details.

content/docs/k8s/reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ PomeriumSpec defines Pomerium-specific configuration parameters.
216216
</p>
217217
<p>
218218
<strong>Required.</strong>&#160;
219-
Secrets references a Secret with Pomerium bootstrap parameters. <p> <ul> <li><a href="https://pomerium.com/docs/reference/shared-secret-settings#shared-secret"><code>shared_secret</code></a> - secures inter-Pomerium service communications. </li> <li><a href="https://pomerium.com/docs/reference/cookie-secret"><code>cookie_secret</code></a> - encrypts Pomerium session browser cookie. See also other <a href="#cookie">Cookie</a> parameters. </li> <li><a href="https://pomerium.com/docs/reference/signing-key-settings#signing-key"><code>signing_key</code></a> signs Pomerium JWT assertion header. See <a href="https://www.pomerium.com/docs/topics/getting-users-identity">Getting the user's identity</a> guide. </li> </ul> </p> <p> In a default Pomerium installation manifest, they would be generated via a <a href="https://github.com/pomerium/ingress-controller/blob/main/config/gen_secrets/job.yaml">one-time job</a> and stored in a <code>pomerium/bootstrap</code> Secret. You may re-run the job to rotate the secrets, or update the Secret values manually. </p>
219+
Secrets references a Secret with Pomerium bootstrap parameters. <p> <ul> <li><a href="https://pomerium.com/docs/reference/shared-secret#shared-secret"><code>shared_secret</code></a> - secures inter-Pomerium service communications. </li> <li><a href="https://pomerium.com/docs/reference/cookie-secret"><code>cookie_secret</code></a> - encrypts Pomerium session browser cookie. See also other <a href="#cookie">Cookie</a> parameters. </li> <li><a href="https://pomerium.com/docs/reference/signing-key#signing-key"><code>signing_key</code></a> signs Pomerium JWT assertion header. See <a href="https://www.pomerium.com/docs/topics/getting-users-identity">Getting the user's identity</a> guide. </li> </ul> </p> <p> In a default Pomerium installation manifest, they would be generated via a <a href="https://github.com/pomerium/ingress-controller/blob/main/config/gen_secrets/job.yaml">one-time job</a> and stored in a <code>pomerium/bootstrap</code> Secret. You may re-run the job to rotate the secrets, or update the Secret values manually. </p>
220220
</p>
221221
222222
Format: reference to Kubernetes resource with namespace prefix: <code>namespace/name</code> format.

content/docs/reference/downstream-mtls-settings.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ The Ingress Controller does not support these settings.
168168

169169
This matches the default behavior of many popular reverse proxies, such as Apache httpd and Caddy.
170170

171-
Note that in this mode, client certificates will be required even for internal Pomerium routes, such as the authenticate URL (if using the self-hosted authenticate service) and the /.pomerium/ page (the page showing details of a user's current login session). In particular, any upstream services that perform [JWT verification](/docs/capabilities/getting-users-identity) will not be able to access the default [JWKS endpoint](/docs/reference/signing-key-settings#signing-key#how-to-use-signing-key). You may need to host your own JWKS endpoint, or provide some other means of distributing the JWT verification key(s).
171+
Note that in this mode, client certificates will be required even for internal Pomerium routes, such as the authenticate URL (if using the self-hosted authenticate service) and the /.pomerium/ page (the page showing details of a user's current login session). In particular, any upstream services that perform [JWT verification](/docs/capabilities/getting-users-identity) will not be able to access the default [JWKS endpoint](/docs/reference/signing-key#signing-key#how-to-use-signing-key). You may need to host your own JWKS endpoint, or provide some other means of distributing the JWT verification key(s).
172172

173173
This mode also adds a requirement that any configured [**CRL**](#crl) is valid only between its `thisUpdate` and `nextUpdate` timestamps. _If an invalid CRL is provided for a certain CA, no certificates issued by that CA will be allowed._
174174

content/docs/troubleshooting.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Events:
148148

149149
### Shared Secret Mismatch
150150

151-
Pomerium's independent services communicate securely using a [shared secret](/docs/reference/shared-secret-settings#shared-secret). When Pomerium services share a mismatched secret, or these services share a secret that is not the same secret set in the Databroker service, Pomerium will fail.
151+
Pomerium's independent services communicate securely using a [shared secret](/docs/reference/shared-secret#shared-secret). When Pomerium services share a mismatched secret, or these services share a secret that is not the same secret set in the Databroker service, Pomerium will fail.
152152

153153
Pomerium Core will log a shared secret mismatch with:
154154

@@ -182,7 +182,7 @@ Pomerium Enterprise will log a shared secret mismatch with:
182182
}
183183
```
184184

185-
Update the [shared secret](/docs/reference/shared-secret-settings#shared-secret) across all Pomerium services to match the one set for the Databroker.
185+
Update the [shared secret](/docs/reference/shared-secret#shared-secret) across all Pomerium services to match the one set for the Databroker.
186186

187187
### RPC Errors
188188

content/examples/tooljet/config-tooljet.yaml.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ idp_provider: github
66
idp_client_id: REPLACE_ME
77
idp_client_secret: REPLACE_ME
88

9-
# Update the signing key: https://www.pomerium.com/docs/reference/signing-key-settings#signing-key
9+
# Update the signing key: https://www.pomerium.com/docs/reference/signing-key#signing-key
1010
signing_key: LS0tLS1CRUdJTiBFQyBQUklWQVRFIEtFWS0tLS0tCk1IY0NBUUVFSURRemVZWDZyT2tuemFnTjRJVTYxaEtRc3pzY1EvRllmbzZPcXhWd2YvdGZvQW9HQ0NxR1NNNDkKQXdFSG9VUURRZ0FFc1V0V2psYXZ3eHprSU9DVUNDeFVnTDJza2NjL3QxSTFmQXlxUDgrMWw5YU1CWDlzdm1pYgpRajJxcWFUbUJZZWhuQzhmak5LODZmVXhpc3d1SXN5bnp3PT0KLS0tLS1FTkQgRUMgUFJJVkFURSBLRVktLS0tLQo=
1111

1212
routes:

0 commit comments

Comments
 (0)