Skip to content

Commit 0f5f166

Browse files
nhayfieldnhayfield
authored
Merge branch 'main' into GTAG404
2 parents 45b20e3 + 7d64e62 commit 0f5f166

File tree

5 files changed

+214
-51
lines changed

5 files changed

+214
-51
lines changed

‎content/docs/reference/img/routes/route-description.png

118 KB
Loading

‎content/docs/reference/reference.json

+31-8
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"id": "address",
2222
"title": "Address",
2323
"path": "/address",
24-
"description": "Specifies the Host and Port to serve HTTP requests from.",
24+
"description": "Specifies the IP Address and Port to serve HTTP requests from.",
2525
"short_description": "",
2626
"type": "string",
2727
"services": ["proxy"]
@@ -439,7 +439,7 @@
439439
"id": "http-redirect-address",
440440
"title": "HTTP Redirect Address",
441441
"path": "/http-redirect-address",
442-
"description": "If set, HTTP Redirect Address specifies the Host and Port to redirect HTTP to HTTPS traffic on.",
442+
"description": "If set, HTTP Redirect Address specifies the IP Address and Port to redirect HTTP to HTTPS traffic on.",
443443
"services": [],
444444
"type": "string"
445445
},
@@ -546,17 +546,24 @@
546546
"path": "/tracing",
547547
"services": []
548548
},
549-
"tracing-provider": {
550-
"id": "tracing-provider",
549+
"tracing-otlp-endpoint": {
550+
"id": "tracing-otlp-endpoint",
551551
"title": "Tracing Provider",
552-
"description": "The name of the tracing provider. For example, Jaeger or Zipkin. Required.",
552+
"description": "Endpoint URL for OTLP trace data. Required.",
553+
"path": "/tracing",
554+
"services": []
555+
},
556+
"tracing-otlp-protocol": {
557+
"id": "tracing-otlp-endpoint",
558+
"title": "Tracing Provider",
559+
"description": "Transport protocol to be used for OTLP trace data.",
553560
"path": "/tracing",
554561
"services": []
555562
},
556563
"tracing-sample-rate": {
557564
"id": "tracing-sample-rate",
558565
"title": "Tracing Sample Rate",
559-
"description": "The percentage of requests to sample in decimal notation. Default is 0.0001, or .01%. Optional.",
566+
"description": "The percentage of requests to sample. Default is 100%.",
560567
"path": "/tracing",
561568
"services": []
562569
},
@@ -797,6 +804,14 @@
797804
"description": "Allows unauthenticated HTTP OPTIONS requests.",
798805
"type": "bool"
799806
},
807+
"description": {
808+
"id": "description",
809+
"title": "Description",
810+
"path": "/routes/description",
811+
"services": ["proxy"],
812+
"description": "Description of the route.",
813+
"type": "string"
814+
},
800815
"enable-google-cloud-serverless-authentication": {
801816
"id": "enable-google-cloud-serverless-authentication",
802817
"title": "Enable Google Cloud Serverless Authentication",
@@ -1057,9 +1072,9 @@
10571072
},
10581073
"logo-url": {
10591074
"id": "logo-url",
1060-
"title": "Logo Url",
1075+
"title": "Logo URL",
10611076
"path": "/branding#logo-url",
1062-
"description": "A Url pointing to your logo. Defaults to Pomerium's Logo.",
1077+
"description": "A URL pointing to your logo. Defaults to Pomerium's Logo.",
10631078
"services": [],
10641079
"type": "URL"
10651080
},
@@ -1318,6 +1333,14 @@
13181333
"description": "Modifies response headers before they are returned to the client. 'Header' matches the HTTP header name; 'prefix' will be replaced with 'value'.",
13191334
"type": "object"
13201335
},
1336+
"route-logo-url": {
1337+
"id": "route-logo-url",
1338+
"title": "Route Logo URL",
1339+
"path": "/routes/logo-url",
1340+
"services": ["proxy"],
1341+
"description": "The route logo URL.",
1342+
"type": "URL"
1343+
},
13211344
"route-timeout": {
13221345
"id": "route-timeout",
13231346
"title": "Route Timeout",

‎content/docs/reference/routes/description.mdx

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: description
3+
title: Route Description
4+
keywords:
5+
- reference
6+
- Route Description
7+
pagination_prev: null
8+
pagination_next: null
9+
toc_max_heading_level: 2
10+
---
11+
12+
import Tabs from '@theme/Tabs';
13+
import TabItem from '@theme/TabItem';
14+
15+
# Route Description
16+
17+
## Summary
18+
19+
Route description shown in the routes portal.
20+
21+
## How to configure
22+
23+
<Tabs>
24+
<TabItem value="Core" label="Core">
25+
26+
| **Config file key** | **Type** | **Usage** |
27+
| :------------------ | :------- | :----------- |
28+
| `description` | `string` | **optional** |
29+
30+
</TabItem>
31+
<TabItem value="Enterprise" label="Enterprise">
32+
33+
Set the route **description** under **General** route settings in the Console:
34+
35+
![Set the route **description** under **General** route settings in the Console](../img/routes/route-description.png)
36+
37+
</TabItem>
38+
<TabItem value="Kubernetes" label="Kubernetes">
39+
40+
| **[Annotation name](/docs/deploy/k8s/ingress#set-ingress-annotations)** | **Type** | **Usage** |
41+
| :-- | :-- | :-- |
42+
| `description` | `string` | **optional** |
43+
44+
</TabItem>
45+
</Tabs>

‎content/docs/reference/routes/logo-url.mdx

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: logo-url
3+
title: Route Logo URL
4+
keywords:
5+
- reference
6+
- Route Logo URL
7+
pagination_prev: null
8+
pagination_next: null
9+
toc_max_heading_level: 2
10+
---
11+
12+
import Tabs from '@theme/Tabs';
13+
import TabItem from '@theme/TabItem';
14+
15+
# Route Logo URL
16+
17+
## Summary
18+
19+
Route logo URL shown in the routes portal.
20+
21+
## How to configure
22+
23+
<Tabs>
24+
<TabItem value="Core" label="Core">
25+
26+
| **Config file key** | **Type** | **Usage** |
27+
| :------------------ | :------- | :----------- |
28+
| `logo_url` | `string` | **optional** |
29+
30+
</TabItem>
31+
<TabItem value="Enterprise" label="Enterprise">
32+
33+
Set the route **logo URL** under **General** route settings in the Console:
34+
35+
![Set the route **logo URL** under **General** route settings in the Console](../img/routes/route-description.png)
36+
37+
</TabItem>
38+
<TabItem value="Kubernetes" label="Kubernetes">
39+
40+
| **[Annotation name](/docs/deploy/k8s/ingress#set-ingress-annotations)** | **Type** | **Usage** |
41+
| :-- | :-- | :-- |
42+
| `logo_url` | `string` | **optional** |
43+
44+
</TabItem>
45+
</Tabs>

‎static/_redirects

+93-43
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,50 @@ https://docs.pomerium.io/* https://docs.pomerium.com/:splat 301!
136136
/_generate-recovery-token.html /docs/admonitions/_generate-recovery-token
137137
/_install-mkcert /docs/admonitions/_install-mkcert
138138
/_install-mkcert.html /docs/admonitions/_install-mkcert
139-
/docs/manage/custom-domains /docs/capabilities/custom-domains
140-
/docs/manage/custom-domains.html /docs/capabilities/custom-domains
139+
/docs/capabilities/certificates-and-tls /docs/internals/certificates-and-tls
140+
/docs/capabilities/certificates-and-tls.html /docs/internals/certificates-and-tls
141+
/docs/capabilities/device-identity /docs/integrations/device-context/device-identity
142+
/docs/capabilities/directory-sync /docs/integrations/user-standing/directory-sync
143+
/docs/capabilities/directory-sync.html /docs/integrations/user-standing/directory-sync
144+
/docs/capabilities/enterprise-api /docs/internals/management-api-enterprise
145+
/docs/capabilities/enterprise-api.html /docs/internals/management-api-enterprise
146+
/docs/capabilities/high-availability /docs/internals/configuration
147+
/docs/capabilities/high-availability.html /docs/internals/configuration
148+
/docs/capabilities/hosted-authenticate-service /docs/capabilities/authentication#hosted-authenticate-service
149+
/docs/capabilities/load-balancing /docs/capabilities/routing#load-balancer
150+
/docs/capabilities/metrics /docs/internals/metrics
151+
/docs/capabilities/metrics.html /docs/internals/metrics
152+
/docs/capabilities/mtls-clients /docs/internals/certificates-and-tls#downstream-tls
153+
/docs/capabilities/mtls-services /docs/internals/certificates-and-tls#upstream-tls
154+
/docs/capabilities/namespacing /docs/internals/namespacing
155+
/docs/capabilities/ppl /docs/internals/ppl
156+
/docs/capabilities/ppl.html /docs/internals/ppl
157+
/docs/capabilities/programmatic-access /docs/internals/programmatic-access
158+
/docs/capabilities/programmatic-access.html /docs/internals/programmatic-access
159+
/docs/capabilities/rego /docs/internals/ppl#rego
160+
/docs/capabilities/self-hosted-authenticate-service /docs/capabilities/authentication#self-hosted-authenticate-service
161+
/docs/capabilities/single-sign-out /docs/capabilities/authentication#single-sign-out-sso
162+
/docs/capabilities/tcp/client /docs/capabilities/non-http/client
163+
/docs/capabilities/tcp/examples/git /docs/capabilities/non-http/examples/git
164+
/docs/capabilities/tcp/examples/mysql /docs/capabilities/non-http/examples/mysql
165+
/docs/capabilities/tcp/examples/ssh /docs/capabilities/non-http/examples/ssh
166+
/docs/clients/pomerium-desktop /docs/deploy/clients
167+
/docs/community/security /docs/internals/security
168+
/docs/concepts/policies /docs/capabilities/authorization
169+
/docs/concepts/zero-trust /docs/internals/zero-trust
170+
/docs/core/from-source /docs/deploy/core
171+
/docs/core/upgrading /docs/deploy/upgrading
172+
/docs/courses/fundamentals/jwt-verification /docs/get-started/fundamentals/core/jwt-verification
173+
/docs/courses/fundamentals/self-hosted-pomerium /docs/get-started/fundamentals/core/self-hosted-pomerium
174+
/docs/deploy/cloud/api-guide /docs/internals/management-api-zero
175+
/docs/deploy/cloud/api-guide.html /docs/internals/management-api-zero
176+
/docs/deploy/enterprise/about/ /docs/deploy/enterprise
177+
/docs/deploy/enterprise/reference/configure.html /docs/deploy/enterprise/configure
178+
/docs/deploy/enterprise/upgrading.html /docs/deploy/upgrading
179+
/docs/deploying/k8s/quickstart /docs/deploy/k8s/quickstart
180+
/docs/enterprise/configure /docs/deploy/enterprise/configure
181+
/docs/enterprise/external-data/geoip /docs/integrations/request-context/geoip
182+
/docs/enterprise/external-data/ip-ranges /docs/integrations/request-context/ip-ranges
141183
/docs/get-started/fundamentals/advanced-policies /docs/get-started/fundamentals/core/advanced-policies
142184
/docs/get-started/fundamentals/advanced-policies.html /docs/get-started/fundamentals/core/advanced-policies
143185
/docs/get-started/fundamentals/advanced-routes /docs/get-started/fundamentals/core/advanced-routes
@@ -172,26 +214,32 @@ https://docs.pomerium.io/* https://docs.pomerium.com/:splat 301!
172214
/docs/get-started/fundamentals/zero-single-sign-on.html /docs/get-started/fundamentals/zero/zero-single-sign-on
173215
/docs/get-started/fundamentals/zero-tcp-routes /docs/get-started/fundamentals/zero/zero-tcp-routes
174216
/docs/get-started/fundamentals/zero-tcp-routes.html /docs/get-started/fundamentals/zero/zero-tcp-routes
175-
/docs/integrations/integrations /docs/capabilities/integrations
176-
/docs/integrations/integrations.html /docs/capabilities/integrations
177-
/docs/integrations/fleetdm /docs/integrations/device-context/fleetdm
178-
/docs/integrations/fleetdm.html /docs/integrations/device-context/fleetdm
179-
/docs/integrations/geoip /docs/integrations/request-context/geoip
180-
/docs/integrations/geoip.html /docs/integrations/request-context/geoip
181-
/docs/integrations/ip-ranges /docs/integrations/request-context/ip-ranges
182-
/docs/integrations/ip-ranges.html /docs/integrations/request-context/ip-ranges
183-
/docs/integrations/tor-exit-nodes /docs/integrations/request-context/tor-exit-nodes
184-
/docs/integrations/tor-exit-nodes.html /docs/integrations/request-context/tor-exit-nodes
185-
/docs/integrations/vpn-providers /docs/integrations/request-context/vpn-providers
186-
/docs/integrations/vpn-providers.html /docs/integrations/request-context/vpn-providers
217+
/docs/guides/jwt-verification-with-envoy /docs/capabilities/getting-users-identity
218+
/docs/guides/kubernetes.html /docs/deploy/k8s/quickstart
219+
/docs/guides/nginx https://0-20-0.docs.pomerium.com/docs/guides/nginx 301!
220+
/docs/guides/nginx.html https://0-20-0.docs.pomerium.com/docs/guides/nginx 301!
221+
/docs/guides/upstream-mtls.html /docs/capabilities/mtls-services
222+
/docs/identity-providers /docs/integrations/user-identity/identity-providers
223+
/docs/identity-providers/apple /docs/integrations/user-identity/apple
224+
/docs/identity-providers/auth0 /docs/integrations/user-identity/auth0
225+
/docs/identity-providers/azure /docs/integrations/user-identity/azure
226+
/docs/identity-providers/gitlab /docs/integrations/user-identity/gitlab
227+
/docs/identity-providers/gitlab.html /docs/integrations/user-identity/gitlab
228+
/docs/identity-providers/google /docs/integrations/user-identity/google
187229
/docs/integrations/apple /docs/integrations/user-identity/apple
188230
/docs/integrations/apple.html /docs/integrations/user-identity/apple
189231
/docs/integrations/auth0 /docs/integrations/user-identity/auth0
190232
/docs/integrations/auth0.html /docs/integrations/user-identity/auth0
191233
/docs/integrations/azure /docs/integrations/user-identity/azure
192234
/docs/integrations/azure.html /docs/integrations/user-identity/azure
235+
/docs/integrations/bamboohr /docs/integrations/user-standing/bamboohr
236+
/docs/integrations/bamboohr.html /docs/integrations/user-standing/bamboohr
193237
/docs/integrations/cognito /docs/integrations/user-identity/cognito
194238
/docs/integrations/cognito.html /docs/integrations/user-identity/cognito
239+
/docs/integrations/fleetdm /docs/integrations/device-context/fleetdm
240+
/docs/integrations/fleetdm.html /docs/integrations/device-context/fleetdm
241+
/docs/integrations/geoip /docs/integrations/request-context/geoip
242+
/docs/integrations/geoip.html /docs/integrations/request-context/geoip
195243
/docs/integrations/github /docs/integrations/user-identity/github
196244
/docs/integrations/github.html /docs/integrations/user-identity/github
197245
/docs/integrations/gitlab /docs/integrations/user-identity/gitlab
@@ -200,46 +248,48 @@ https://docs.pomerium.io/* https://docs.pomerium.com/:splat 301!
200248
/docs/integrations/google.html /docs/integrations/user-identity/google
201249
/docs/integrations/index /docs/integrations/user-identity/identity-providers
202250
/docs/integrations/index.html /docs/integrations/user-identity/identity-providers
251+
/docs/integrations/integrations /docs/capabilities/integrations
252+
/docs/integrations/integrations.html /docs/capabilities/integrations
253+
/docs/integrations/ip-ranges /docs/integrations/request-context/ip-ranges
254+
/docs/integrations/ip-ranges.html /docs/integrations/request-context/ip-ranges
203255
/docs/integrations/okta /docs/integrations/user-identity/okta
204256
/docs/integrations/okta.html /docs/integrations/user-identity/okta
205257
/docs/integrations/one-login /docs/integrations/user-identity/one-login
206258
/docs/integrations/one-login.html /docs/integrations/user-identity/one-login
207259
/docs/integrations/ping /docs/integrations/user-identity/ping
208260
/docs/integrations/ping.html /docs/integrations/user-identity/ping
209-
/docs/integrations/bamboohr /docs/integrations/user-standing/bamboohr
210-
/docs/integrations/bamboohr.html /docs/integrations/user-standing/bamboohr
211-
/docs/capabilities/directory-sync /docs/integrations/user-standing/directory-sync
212-
/docs/capabilities/directory-sync.html /docs/integrations/user-standing/directory-sync
261+
/docs/integrations/tor-exit-nodes /docs/integrations/request-context/tor-exit-nodes
262+
/docs/integrations/tor-exit-nodes.html /docs/integrations/request-context/tor-exit-nodes
263+
/docs/integrations/vpn-providers /docs/integrations/request-context/vpn-providers
264+
/docs/integrations/vpn-providers.html /docs/integrations/request-context/vpn-providers
213265
/docs/integrations/zenefits /docs/integrations/user-standing/zenefits
214266
/docs/integrations/zenefits.html /docs/integrations/user-standing/zenefits
215-
/docs/capabilities/certificates-and-tls /docs/internals/certificates-and-tls
216-
/docs/capabilities/certificates-and-tls.html /docs/internals/certificates-and-tls
267+
/docs/k8s/helm.html /docs/deploy/k8s/install
268+
/docs/k8s/ingress.html /docs/deploy/k8s/ingress
269+
/docs/k8s/quickstart /docs/deploy/k8s/quickstart
217270
/docs/manage/clusters /docs/internals/clusters
218271
/docs/manage/clusters.html /docs/internals/clusters
219-
/docs/capabilities/high-availability /docs/internals/configuration
220-
/docs/capabilities/high-availability.html /docs/internals/configuration
221-
/docs/capabilities/enterprise-api /docs/internals/management-api-enterprise
222-
/docs/capabilities/enterprise-api.html /docs/internals/management-api-enterprise
223-
/docs/deploy/cloud/api-guide /docs/internals/management-api-zero
224-
/docs/deploy/cloud/api-guide.html /docs/internals/management-api-zero
272+
/docs/manage/custom-domains /docs/capabilities/custom-domains
273+
/docs/manage/custom-domains.html /docs/capabilities/custom-domains
225274
/docs/manage/mutual-auth /docs/internals/mutual-auth
226275
/docs/manage/mutual-auth.html /docs/internals/mutual-auth
227-
/docs/capabilities/metrics /docs/internals/metrics
228-
/docs/capabilities/metrics.html /docs/internals/metrics
229-
/docs/capabilities/ppl /docs/internals/ppl
230-
/docs/capabilities/ppl.html /docs/internals/ppl
231-
/docs/capabilities/programmatic-access /docs/internals/programmatic-access
232-
/docs/capabilities/programmatic-access.html /docs/internals/programmatic-access
233276
/docs/manage/troubleshooting /docs/internals/troubleshooting
234277
/docs/manage/troubleshooting.html /docs/internals/troubleshooting
235-
236-
# Additional old capabilities => new locations
237-
/docs/capabilities/rego /docs/internals/ppl#rego
238-
/docs/capabilities/namespacing /docs/internals/namespacing
239-
/docs/capabilities/load-balancing /docs/capabilities/routing#load-balancer
240-
/docs/capabilities/device-identity /docs/integrations/device-context/device-identity
241-
/docs/capabilities/single-sign-out /docs/capabilities/authentication#single-sign-out-sso
242-
/docs/capabilities/mtls-clients /docs/internals/certificates-and-tls#downstream-tls
243-
/docs/capabilities/mtls-services /docs/internals/certificates-and-tls#upstream-tls
244-
/docs/capabilities/hosted-authenticate-service /docs/capabilities/authentication#hosted-authenticate-service
245-
/docs/capabilities/self-hosted-authenticate-service /docs/capabilities/authentication#self-hosted-authenticate-service
278+
/docs/reference/authenticate-internal-service-url /docs/reference/service-urls
279+
/docs/reference/autocert/autocert-must-staple /docs/reference/autocert#autocert-must-staple
280+
/docs/reference/branding/logo-url /docs/reference/branding#logo-url
281+
/docs/reference/cookie-secure /docs/reference/cookies#cookie-secure
282+
/docs/reference/forward-auth https://0-20-0.docs.pomerium.com/docs/reference/forward-auth 301!
283+
/docs/reference/metrics-basic-authentication /docs/deploy/enterprise/configure-metrics
284+
/docs/reference/reference.html /docs/reference
285+
/docs/releases/pomerium-cli /docs/deploy/clients
286+
/docs/topics/device-identity.html /docs/integrations/device-context/device-identity
287+
/docs/topics/mutual-auth.html /docs/internals/mutual-auth
288+
/docs/topics/original-request-context /docs/capabilities/original-request-context
289+
/docs/topics/ppl /docs/internals/ppl
290+
/docs/topics/production-deployment.html /docs/deploy/upgrading
291+
/docs/topics/programmatic-access.html /docs/internals/programmatic-access
292+
/docs/troubleshooting /docs/internals/troubleshooting
293+
/docs/zero/billing /docs/deploy/cloud/billing
294+
/docs/zero/import /docs/deploy/cloud/import
295+
/recipes/ad-guard /docs/guides/ad-guard

0 commit comments

Comments
 (0)