From 60700228ce67644bf9e111c1343bf3807259772f Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Mon, 14 Jul 2025 14:19:42 -0700 Subject: [PATCH 01/24] first pass at structure --- docs/universal-gateway/overview.mdx | 54 ++++------------------------- 1 file changed, 7 insertions(+), 47 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index dcbc49e7a0..c45d27618c 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -4,58 +4,18 @@ sidebar_label: Overview pagination_next: universal-gateway/domains --- -# Universal Gateway +## What is the Universal Gateway? ngrok's Universal Gateway is a suite of common tools for building API and device gateways, identity-aware proxies, and site-to-site connectivity. -It secures, accelerates, and protects your applications. -We call it a Universal Gateway because it supports [TCP](/universal-gateway/tcp/) and [TLS](/universal-gateway/tls/) applications as well as [HTTP/S](/universal-gateway/http/). -## Concepts +### What makes it "universal"? -Dive into the different parts of the Universal Gateway like Endpoints, Bindings, Pools, and Domains to understand how they work. +### Key features -Learn more about Universal Gateway Concepts: +### How it works -- [Domains →](/universal-gateway/domains/) -- [TCP Addresses →](/universal-gateway/tcp-addresses/) -- [TLS Certificates →](/universal-gateway/tls-certificates/) -- [Edges →](/universal-gateway/edges/) +## Get started -## Endpoints +### Common use cases -[Endpoints](/universal-gateway/endpoints/) are how ngrok enables traffic to reach your services. - -Learn more about Endpoints: - -- [Bindings →](/universal-gateway/bindings/) -- [Internal Endpoints →](/universal-gateway/internal-endpoints/) -- [Public Endpoints →](/universal-gateway/public-endpoints/) -- [Kubernetes Endpoints →](/universal-gateway/kubernetes-endpoints/) - -## Load Balancing - -Endpoints Pools make load balancing dead simple. -When your create two endpoints with the same URL (and binding), those endpoints automatically "pool" together and traffic to their URL is balanced among them. - -- [Learn more about Load Balancing with Endpoint Pools →](/universal-gateway/endpoint-pooling/) - -## TLS - -ngrok automatically handles TLS (SSL) termination and certificate management for you. -There is typically nothing to setup, configure, or manage. - -- [Learn more about TLS Certificates →](/universal-gateway/tls-certificates/) -- [Learn more about the TLS Termination →](/universal-gateway/tls-termination/) - -## Global Load Balancer - -ngrok's Global Load Balancer automatically improves the performance and resiliency of your applications by distributing traffic to the nearest healthy point of presence, measured by latency, from the perspective of the connecting client. - -- [Learn more about the Global Load Balancer →](/universal-gateway/global-load-balancer/) -- [See ngrok's Global Points of Presence →](/universal-gateway/points-of-presence) - -## DDoS Protection - -ngrok automatically protects your applications with out-of-the-box protection from distributed denial-of-service (DDoS) attacks. - -- [Learn more about DDoS Protection →](/universal-gateway/ddos-protection) +## What's next? \ No newline at end of file From 371aece4452c6f0ea05b3c08460c8c59d8f2e84d Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Mon, 14 Jul 2025 14:40:30 -0700 Subject: [PATCH 02/24] framing --- docs/universal-gateway/overview.mdx | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index c45d27618c..728f9daeeb 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -7,12 +7,20 @@ pagination_next: universal-gateway/domains ## What is the Universal Gateway? ngrok's Universal Gateway is a suite of common tools for building API and device gateways, identity-aware proxies, and site-to-site connectivity. +Check out the [Front Door Pattern](/universal-gateway/examples/front-door-pattern/) to see one of the most common use cases. ### What makes it "universal"? -### Key features +Universal Gateway's features are compatible with HTTP/S, TCP, and TLS applications. -### How it works +## Key concepts + +- Domains +- TCP +- TLS +- Endpoints +- Load balancing +- DDoS protection ## Get started From 4fa67d9c02ae6a6b2a59f0a178bb9c00552356d2 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Tue, 15 Jul 2025 10:06:48 -0700 Subject: [PATCH 03/24] elaborating --- docs/universal-gateway/overview.mdx | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 728f9daeeb..7d6bc7934d 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -7,11 +7,16 @@ pagination_next: universal-gateway/domains ## What is the Universal Gateway? ngrok's Universal Gateway is a suite of common tools for building API and device gateways, identity-aware proxies, and site-to-site connectivity. -Check out the [Front Door Pattern](/universal-gateway/examples/front-door-pattern/) to see one of the most common use cases. + ### What makes it "universal"? Universal Gateway's features are compatible with HTTP/S, TCP, and TLS applications. +It can be used with software running locally or in the cloud, and with devices running on-premises or distributed in the field. + +### Common use cases + +Check out the [Front Door Pattern](/universal-gateway/examples/front-door-pattern/) to see one of the most common use cases. ## Key concepts @@ -24,6 +29,4 @@ Universal Gateway's features are compatible with HTTP/S, TCP, and TLS applicatio ## Get started -### Common use cases - ## What's next? \ No newline at end of file From 5cda8ba79bd297a9173720a4620937c0b976d4e6 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Tue, 15 Jul 2025 16:07:38 -0700 Subject: [PATCH 04/24] expanding --- docs/universal-gateway/overview.mdx | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 7d6bc7934d..0839757146 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -8,15 +8,10 @@ pagination_next: universal-gateway/domains ngrok's Universal Gateway is a suite of common tools for building API and device gateways, identity-aware proxies, and site-to-site connectivity. +**What makes it "universal"?** +The Universal Gateway flexible and composable platform that can be used with software running locally or in the cloud, and with devices running on-premises or distributed in the field. -### What makes it "universal"? - -Universal Gateway's features are compatible with HTTP/S, TCP, and TLS applications. -It can be used with software running locally or in the cloud, and with devices running on-premises or distributed in the field. - -### Common use cases - -Check out the [Front Door Pattern](/universal-gateway/examples/front-door-pattern/) to see one of the most common use cases. +You can deliver traffic to internal and public APIs, orchestrate traffic across your devices. expose services from any location. globally distributed by default. unified routing, dynamic traffic policy support to offload non-critical business logic on to the gateway. support across multiple environments and security with minimal configuration. developer-first experience, self-service, automate your services. traffic introspection, observability, events system, traffic inspector. ## Key concepts @@ -29,4 +24,8 @@ Check out the [Front Door Pattern](/universal-gateway/examples/front-door-patter ## Get started +### Common use cases + +Check out the [Front Door Pattern](/universal-gateway/examples/front-door-pattern/) to see one of the most common use cases. + ## What's next? \ No newline at end of file From 21ee3b041c07baa5ed38e7a3414a0ff60243ad66 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Tue, 15 Jul 2025 23:08:30 +0000 Subject: [PATCH 05/24] ci: apply automated fixes --- docs/universal-gateway/overview.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 0839757146..508068aec0 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -15,7 +15,7 @@ You can deliver traffic to internal and public APIs, orchestrate traffic across ## Key concepts -- Domains +- Domains - TCP - TLS - Endpoints @@ -28,4 +28,4 @@ You can deliver traffic to internal and public APIs, orchestrate traffic across Check out the [Front Door Pattern](/universal-gateway/examples/front-door-pattern/) to see one of the most common use cases. -## What's next? \ No newline at end of file +## What's next? From 675fd0b11a9d9f1cb17d3b642383a21482aeb5db Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Thu, 17 Jul 2025 11:02:42 -0700 Subject: [PATCH 06/24] full pass up to whats next --- docs/universal-gateway/overview.mdx | 71 ++++++++++++++++++++++++----- 1 file changed, 59 insertions(+), 12 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 508068aec0..88ca76e0e5 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -9,23 +9,70 @@ pagination_next: universal-gateway/domains ngrok's Universal Gateway is a suite of common tools for building API and device gateways, identity-aware proxies, and site-to-site connectivity. **What makes it "universal"?** -The Universal Gateway flexible and composable platform that can be used with software running locally or in the cloud, and with devices running on-premises or distributed in the field. +The Universal Gateway is a flexible and composable platform that can be used with software running locally or in the cloud, and with devices running on-premises or distributed in the field. +You can deliver traffic to internal and public APIs as well as orchestrate traffic across your devices. +It's globally distributed by default and provides support across multiple environments with minimal configuration. -You can deliver traffic to internal and public APIs, orchestrate traffic across your devices. expose services from any location. globally distributed by default. unified routing, dynamic traffic policy support to offload non-critical business logic on to the gateway. support across multiple environments and security with minimal configuration. developer-first experience, self-service, automate your services. traffic introspection, observability, events system, traffic inspector. +:::tip +Check out the [front door pattern](/universal-gateway/examples/front-door-pattern/) in the [examples collection](/universal-gateway/examples/) to see one of the most common use cases. +::: -## Key concepts +## Universal Gateway features -- Domains -- TCP -- TLS -- Endpoints -- Load balancing -- DDoS protection +### Traffic Policy -## Get started +ngrok's Traffic Policy is a configuration language that offers you the flexibility to filter, match, manage and orchestrate traffic to your endpoints. -### Common use cases +With ngrok's Traffic Policy you can: -Check out the [Front Door Pattern](/universal-gateway/examples/front-door-pattern/) to see one of the most common use cases. +- Validate incoming traffic +- Block malicious traffic +- Rewrite URLs +- Respond with custom content +- Forward traffic to your agents running across the globe + +Because you can add traffic policies to any type of ngrok endpoint, you can use them to scope traffic management for each of your endpoints. +For example, API teams can manage a traffic policy for their internal services while devops or security teams can manage policies for public services. + +### Kubernetes Operator + +The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments. +It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. + +You should use the ngrok Kubernetes Operator if you want to: + +Send traffic to your Kubernetes workloads +Integrate Kubernetes workloads with workloads outside of Kubernetes, such as those running on virtual machines, bare metal, embedded devices, and anywhere else you can run ngrok +Perform cross-cluster networking +Use Kubernetes with ngrok without using ngrok's SDKs + +### Traffic Observability + +#### Traffic Inspector + +Traffic Inspector gives you a view into the HTTP traffic flowing through the endpoints in your account. You can choose whether Traffic Inspector captures only request metadata or full request and response bodies. You can even replay requests against your endpoints for easy debugging replication. + +#### Log exporting + +Whenever changes occur in your ngrok account or when traffic transits through your endpoints, an event is fired. You may subscribe to these events and publish them to destinations like AWS Cloudwatch Logs, AWS Firehose, AWS S3, Datadog Logs, Azure Monitor and more. + +### Identify and access management + +ngrok includes a robust identity and access management (IAM) system. +ngrok's IAM functionality enables you to: + +- Issue, rotate and revoke unique credentials for each principal in your account (either a human user or an automated process). +- Enforce least-privilege access for each principal acting within your ngrok account +- Attribute all mutations to distinct principals in your ngrok account recorded in audit logs +- Configure single sign-on (SSO) to federate identity and SCIM to enable provisioning from your own IdP +- Administrate multiple ngrok accounts with a single user + +## Common use cases + +- [**The front door pattern**](/universal-gateway/examples/front-door-pattern/): A single public endpoint serves as the centralized entrance to all upstream services. +- [**Route to endpoints by geography**](/universal-gateway/examples/route-by-geography/): Forward requests based on IP geolocation data for improved latency or country-specific features. +- [**Create identity-based rate limits**](/universal-gateway/examples/pre-tier-requests/): Pre-tier requests based on your packaging or pricing model. +- [**Secure a public Minecraft server**](/universal-gateway/examples/minecraft/): Restrict server access to a specific set of IP addresses. +- [**Intercept and rewrite headers**](/universal-gateway/examples/rewrite-headers-redirects/): Intercept 302 redirect headers to preserve UX and agent behavior. ## What's next? From 72b3d241e2c86ba05dcf41d6c3da8da6b52013aa Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Thu, 17 Jul 2025 11:10:57 -0700 Subject: [PATCH 07/24] more progress, whats next --- docs/universal-gateway/overview.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 88ca76e0e5..f253cc245e 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -76,3 +76,7 @@ ngrok's IAM functionality enables you to: - [**Intercept and rewrite headers**](/universal-gateway/examples/rewrite-headers-redirects/): Intercept 302 redirect headers to preserve UX and agent behavior. ## What's next? + +- Explore key concepts for working with the Universal Gateway such as [endpoint types](#), [protocols](#), [bindings](#), and [pooling](#). +- Check out the [Universal Gateway examples collection](/docs/universal-gateway/examples/) to see how to implement even more common use cases. +- Proceed to the Guides section to get started with ngrok as an [API gateway](/guides/api-gateway/get-started/), [device gateway](/guides/device-gateway/agent/), [identity-aware proxy](#), or for [site-to-site connectivity](/guides/identity-aware-proxy/securing-with-oauth/). \ No newline at end of file From d9aac91d245c692b0bd02e56e5a751cdf153158b Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Thu, 17 Jul 2025 11:57:40 -0700 Subject: [PATCH 08/24] traffic policy --- docs/universal-gateway/overview.mdx | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index f253cc245e..017f7cab00 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -19,20 +19,14 @@ Check out the [front door pattern](/universal-gateway/examples/front-door-patter ## Universal Gateway features -### Traffic Policy - -ngrok's Traffic Policy is a configuration language that offers you the flexibility to filter, match, manage and orchestrate traffic to your endpoints. +Here are some of the key features of the Universal Gateway platform: -With ngrok's Traffic Policy you can: +### Traffic Policy -- Validate incoming traffic -- Block malicious traffic -- Rewrite URLs -- Respond with custom content -- Forward traffic to your agents running across the globe +ngrok's Traffic Policy is a configuration language for filtering, matching, managing, and orchestrating traffic to your endpoints. +With a Traffic Policy in place, you can validate incoming traffic, block malicious traffic, rewrite URLs, respond with custom content, and more. -Because you can add traffic policies to any type of ngrok endpoint, you can use them to scope traffic management for each of your endpoints. -For example, API teams can manage a traffic policy for their internal services while devops or security teams can manage policies for public services. +Learn more in the [Traffic Policy documentation](/docs/traffic-policy/). ### Kubernetes Operator From 7291853769b2fe12a2195b6dff94838014bdd4f3 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Thu, 17 Jul 2025 12:20:20 -0700 Subject: [PATCH 09/24] new copy, shaquil early feedback --- docs/universal-gateway/overview.mdx | 51 +++++++++++------------------ 1 file changed, 20 insertions(+), 31 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 017f7cab00..712fc24736 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -13,9 +13,15 @@ The Universal Gateway is a flexible and composable platform that can be used wit You can deliver traffic to internal and public APIs as well as orchestrate traffic across your devices. It's globally distributed by default and provides support across multiple environments with minimal configuration. -:::tip -Check out the [front door pattern](/universal-gateway/examples/front-door-pattern/) in the [examples collection](/universal-gateway/examples/) to see one of the most common use cases. -::: +## Common use cases + +Here are some of the most common use cases for the Universal Gateway, from the [examples collection](/universal-gateway/examples/): + +- [**The front door pattern**](/universal-gateway/examples/front-door-pattern/): A single public endpoint serves as the centralized entrance to all upstream services. +- [**Route to endpoints by geography**](/universal-gateway/examples/route-by-geography/): Forward requests based on IP geolocation data for improved latency or country-specific features. +- [**Create identity-based rate limits**](/universal-gateway/examples/pre-tier-requests/): Pre-tier requests based on your packaging or pricing model. +- [**Secure a public Minecraft server**](/universal-gateway/examples/minecraft/): Restrict server access to a specific set of IP addresses. +- [**Intercept and rewrite headers**](/universal-gateway/examples/rewrite-headers-redirects/): Intercept 302 redirect headers to preserve UX and agent behavior. ## Universal Gateway features @@ -30,44 +36,27 @@ Learn more in the [Traffic Policy documentation](/docs/traffic-policy/). ### Kubernetes Operator -The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments. -It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. - -You should use the ngrok Kubernetes Operator if you want to: +ngrok's Kubernetes Operator is the best way to build with the Universal Gateway if your applications run in Kubernetes environments. +It comes with custom resources for configuration and also supports both ingress resources as well as cross-platform Gateway API configuration resources. +You can use the Operator to integrate Kubernetes workloads with workloads outside of Kubernetes, such as those running on virtual machines, bare metal, embedded devices, and anywhere else you can run ngrok. -Send traffic to your Kubernetes workloads -Integrate Kubernetes workloads with workloads outside of Kubernetes, such as those running on virtual machines, bare metal, embedded devices, and anywhere else you can run ngrok -Perform cross-cluster networking -Use Kubernetes with ngrok without using ngrok's SDKs +Learn more in the [Kubernetes Operator documentation](/docs/obs/). -### Traffic Observability +### Traffic observability -#### Traffic Inspector +The Universal Gateway provides several options for observing the traffic flowing through your endpoints, including the Traffic Inspector and ngrok's event logging system. +With Traffic Inspector, you can choose to capture full request and response bodies or just metadata, and replay requests against your endpoints for easy debugging replication. +With ngrok's event logging system, you can subscribe to events triggered whenever traffic transits through your endpoints, and publish them to destinations such as AWS Cloudwatch Logs, AWS Firehose, AWS S3, Datadog Logs, and Azure Monitor. -Traffic Inspector gives you a view into the HTTP traffic flowing through the endpoints in your account. You can choose whether Traffic Inspector captures only request metadata or full request and response bodies. You can even replay requests against your endpoints for easy debugging replication. - -#### Log exporting - -Whenever changes occur in your ngrok account or when traffic transits through your endpoints, an event is fired. You may subscribe to these events and publish them to destinations like AWS Cloudwatch Logs, AWS Firehose, AWS S3, Datadog Logs, Azure Monitor and more. +Learn more in the [traffic observability documentation](/docs/k8s/). ### Identify and access management ngrok includes a robust identity and access management (IAM) system. -ngrok's IAM functionality enables you to: +With ngrok's IAM functionality, you can manage credentials for human users and automated processes; record all changes by principal in audit logs; configure single sign-on (SS0); and more. -- Issue, rotate and revoke unique credentials for each principal in your account (either a human user or an automated process). -- Enforce least-privilege access for each principal acting within your ngrok account -- Attribute all mutations to distinct principals in your ngrok account recorded in audit logs -- Configure single sign-on (SSO) to federate identity and SCIM to enable provisioning from your own IdP -- Administrate multiple ngrok accounts with a single user +Learn more in the [IAM documentation](/docs/iam/). -## Common use cases - -- [**The front door pattern**](/universal-gateway/examples/front-door-pattern/): A single public endpoint serves as the centralized entrance to all upstream services. -- [**Route to endpoints by geography**](/universal-gateway/examples/route-by-geography/): Forward requests based on IP geolocation data for improved latency or country-specific features. -- [**Create identity-based rate limits**](/universal-gateway/examples/pre-tier-requests/): Pre-tier requests based on your packaging or pricing model. -- [**Secure a public Minecraft server**](/universal-gateway/examples/minecraft/): Restrict server access to a specific set of IP addresses. -- [**Intercept and rewrite headers**](/universal-gateway/examples/rewrite-headers-redirects/): Intercept 302 redirect headers to preserve UX and agent behavior. ## What's next? From 08c4ff2d6ae4ae7a81339b0a886f54ec1d1a7212 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Thu, 17 Jul 2025 14:46:37 -0700 Subject: [PATCH 10/24] parallel phrasing --- docs/universal-gateway/overview.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 712fc24736..bc39620a1a 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -17,7 +17,7 @@ It's globally distributed by default and provides support across multiple enviro Here are some of the most common use cases for the Universal Gateway, from the [examples collection](/universal-gateway/examples/): -- [**The front door pattern**](/universal-gateway/examples/front-door-pattern/): A single public endpoint serves as the centralized entrance to all upstream services. +- [**The front door pattern**](/universal-gateway/examples/front-door-pattern/): Set up a single public endpoint to serve as the centralized entrance to all upstream services. - [**Route to endpoints by geography**](/universal-gateway/examples/route-by-geography/): Forward requests based on IP geolocation data for improved latency or country-specific features. - [**Create identity-based rate limits**](/universal-gateway/examples/pre-tier-requests/): Pre-tier requests based on your packaging or pricing model. - [**Secure a public Minecraft server**](/universal-gateway/examples/minecraft/): Restrict server access to a specific set of IP addresses. @@ -38,6 +38,7 @@ Learn more in the [Traffic Policy documentation](/docs/traffic-policy/). ngrok's Kubernetes Operator is the best way to build with the Universal Gateway if your applications run in Kubernetes environments. It comes with custom resources for configuration and also supports both ingress resources as well as cross-platform Gateway API configuration resources. + You can use the Operator to integrate Kubernetes workloads with workloads outside of Kubernetes, such as those running on virtual machines, bare metal, embedded devices, and anywhere else you can run ngrok. Learn more in the [Kubernetes Operator documentation](/docs/obs/). @@ -45,6 +46,7 @@ Learn more in the [Kubernetes Operator documentation](/docs/obs/). ### Traffic observability The Universal Gateway provides several options for observing the traffic flowing through your endpoints, including the Traffic Inspector and ngrok's event logging system. + With Traffic Inspector, you can choose to capture full request and response bodies or just metadata, and replay requests against your endpoints for easy debugging replication. With ngrok's event logging system, you can subscribe to events triggered whenever traffic transits through your endpoints, and publish them to destinations such as AWS Cloudwatch Logs, AWS Firehose, AWS S3, Datadog Logs, and Azure Monitor. From f899385e1ade402158b3ec96d3aeb0f37015475d Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Thu, 17 Jul 2025 14:47:44 -0700 Subject: [PATCH 11/24] ug vs ngrok --- docs/universal-gateway/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index bc39620a1a..ffc19b5da3 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -54,7 +54,7 @@ Learn more in the [traffic observability documentation](/docs/k8s/). ### Identify and access management -ngrok includes a robust identity and access management (IAM) system. +The Universal Gateway includes a robust identity and access management (IAM) system. With ngrok's IAM functionality, you can manage credentials for human users and automated processes; record all changes by principal in audit logs; configure single sign-on (SS0); and more. Learn more in the [IAM documentation](/docs/iam/). From f615d670e3036ca60642db8fddfe824de23b4dc8 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Thu, 17 Jul 2025 14:49:11 -0700 Subject: [PATCH 12/24] common terms vs ngrokisms --- docs/universal-gateway/overview.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index ffc19b5da3..94ee9f0290 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -27,14 +27,14 @@ Here are some of the most common use cases for the Universal Gateway, from the [ Here are some of the key features of the Universal Gateway platform: -### Traffic Policy +### Traffic orchestration ngrok's Traffic Policy is a configuration language for filtering, matching, managing, and orchestrating traffic to your endpoints. With a Traffic Policy in place, you can validate incoming traffic, block malicious traffic, rewrite URLs, respond with custom content, and more. Learn more in the [Traffic Policy documentation](/docs/traffic-policy/). -### Kubernetes Operator +### Kubernetes support ngrok's Kubernetes Operator is the best way to build with the Universal Gateway if your applications run in Kubernetes environments. It comes with custom resources for configuration and also supports both ingress resources as well as cross-platform Gateway API configuration resources. From 5ad818493e6344b8be6e1aaf2fa8a6ef18e71e2e Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Thu, 17 Jul 2025 14:51:39 -0700 Subject: [PATCH 13/24] links --- docs/universal-gateway/overview.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 94ee9f0290..29fc8e1461 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -62,6 +62,6 @@ Learn more in the [IAM documentation](/docs/iam/). ## What's next? -- Explore key concepts for working with the Universal Gateway such as [endpoint types](#), [protocols](#), [bindings](#), and [pooling](#). +- Explore key concepts for working with the Universal Gateway such as [endpoint types](/universal-gateway/types/), [protocols](/universal-gateway/protocols/), [bindings](/universal-gateway/bindings/), and [pooling](/universal-gateway/endpoint-pooling/). - Check out the [Universal Gateway examples collection](/docs/universal-gateway/examples/) to see how to implement even more common use cases. -- Proceed to the Guides section to get started with ngrok as an [API gateway](/guides/api-gateway/get-started/), [device gateway](/guides/device-gateway/agent/), [identity-aware proxy](#), or for [site-to-site connectivity](/guides/identity-aware-proxy/securing-with-oauth/). \ No newline at end of file +- Proceed to the Guides section to get started with ngrok as an [API gateway](/guides/api-gateway/get-started/), [device gateway](/guides/device-gateway/agent/), [identity-aware proxy](/guides/identity-aware-proxy/securing-with-oauth/), or for [site-to-site connectivity](/guides/identity-aware-proxy/securing-with-oauth/). \ No newline at end of file From 90364e3f5a6f62aa33ae68c255651d22cb982fda Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Thu, 17 Jul 2025 14:57:23 -0700 Subject: [PATCH 14/24] small edits, no semi colons --- docs/universal-gateway/overview.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 29fc8e1461..a526db2787 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -30,7 +30,7 @@ Here are some of the key features of the Universal Gateway platform: ### Traffic orchestration ngrok's Traffic Policy is a configuration language for filtering, matching, managing, and orchestrating traffic to your endpoints. -With a Traffic Policy in place, you can validate incoming traffic, block malicious traffic, rewrite URLs, respond with custom content, and more. +You can use it to validate incoming traffic, block malicious traffic, rewrite URLs, respond with custom content, and more. Learn more in the [Traffic Policy documentation](/docs/traffic-policy/). @@ -55,7 +55,7 @@ Learn more in the [traffic observability documentation](/docs/k8s/). ### Identify and access management The Universal Gateway includes a robust identity and access management (IAM) system. -With ngrok's IAM functionality, you can manage credentials for human users and automated processes; record all changes by principal in audit logs; configure single sign-on (SS0); and more. +With ngrok's IAM functionality, you can manage credentials for human users and automated processes, record all changes by principal in audit logs, configure single sign-on (SS0), and more. Learn more in the [IAM documentation](/docs/iam/). From 3183c287d6dafe3847e29df16ea12132314f37c2 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Thu, 17 Jul 2025 21:58:19 +0000 Subject: [PATCH 15/24] ci: apply automated fixes --- docs/universal-gateway/overview.mdx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index a526db2787..1e4b8a8a3f 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -10,7 +10,7 @@ ngrok's Universal Gateway is a suite of common tools for building API and device **What makes it "universal"?** The Universal Gateway is a flexible and composable platform that can be used with software running locally or in the cloud, and with devices running on-premises or distributed in the field. -You can deliver traffic to internal and public APIs as well as orchestrate traffic across your devices. +You can deliver traffic to internal and public APIs as well as orchestrate traffic across your devices. It's globally distributed by default and provides support across multiple environments with minimal configuration. ## Common use cases @@ -36,7 +36,7 @@ Learn more in the [Traffic Policy documentation](/docs/traffic-policy/). ### Kubernetes support -ngrok's Kubernetes Operator is the best way to build with the Universal Gateway if your applications run in Kubernetes environments. +ngrok's Kubernetes Operator is the best way to build with the Universal Gateway if your applications run in Kubernetes environments. It comes with custom resources for configuration and also supports both ingress resources as well as cross-platform Gateway API configuration resources. You can use the Operator to integrate Kubernetes workloads with workloads outside of Kubernetes, such as those running on virtual machines, bare metal, embedded devices, and anywhere else you can run ngrok. @@ -54,14 +54,13 @@ Learn more in the [traffic observability documentation](/docs/k8s/). ### Identify and access management -The Universal Gateway includes a robust identity and access management (IAM) system. +The Universal Gateway includes a robust identity and access management (IAM) system. With ngrok's IAM functionality, you can manage credentials for human users and automated processes, record all changes by principal in audit logs, configure single sign-on (SS0), and more. Learn more in the [IAM documentation](/docs/iam/). - ## What's next? - Explore key concepts for working with the Universal Gateway such as [endpoint types](/universal-gateway/types/), [protocols](/universal-gateway/protocols/), [bindings](/universal-gateway/bindings/), and [pooling](/universal-gateway/endpoint-pooling/). - Check out the [Universal Gateway examples collection](/docs/universal-gateway/examples/) to see how to implement even more common use cases. -- Proceed to the Guides section to get started with ngrok as an [API gateway](/guides/api-gateway/get-started/), [device gateway](/guides/device-gateway/agent/), [identity-aware proxy](/guides/identity-aware-proxy/securing-with-oauth/), or for [site-to-site connectivity](/guides/identity-aware-proxy/securing-with-oauth/). \ No newline at end of file +- Proceed to the Guides section to get started with ngrok as an [API gateway](/guides/api-gateway/get-started/), [device gateway](/guides/device-gateway/agent/), [identity-aware proxy](/guides/identity-aware-proxy/securing-with-oauth/), or for [site-to-site connectivity](/guides/identity-aware-proxy/securing-with-oauth/). From bff9000201a6116d036af110c3d7284cdda9645a Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Thu, 17 Jul 2025 15:07:23 -0700 Subject: [PATCH 16/24] typo --- docs/universal-gateway/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 1e4b8a8a3f..1b2930db68 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -52,7 +52,7 @@ With ngrok's event logging system, you can subscribe to events triggered wheneve Learn more in the [traffic observability documentation](/docs/k8s/). -### Identify and access management +### Identity and access management The Universal Gateway includes a robust identity and access management (IAM) system. With ngrok's IAM functionality, you can manage credentials for human users and automated processes, record all changes by principal in audit logs, configure single sign-on (SS0), and more. From 0c24cd196b3a40528e3dbea408df6f3bc0511222 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Mon, 21 Jul 2025 12:49:28 -0700 Subject: [PATCH 17/24] reduce --- docs/universal-gateway/overview.mdx | 49 +++++++---------------------- 1 file changed, 11 insertions(+), 38 deletions(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 1b2930db68..877eca33ef 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -6,13 +6,22 @@ pagination_next: universal-gateway/domains ## What is the Universal Gateway? -ngrok's Universal Gateway is a suite of common tools for building API and device gateways, identity-aware proxies, and site-to-site connectivity. +ngrok's Universal Gateway is a flexible and composable platform for building API and device gateways, identity-aware proxies, and site-to-site connectivity. **What makes it "universal"?** -The Universal Gateway is a flexible and composable platform that can be used with software running locally or in the cloud, and with devices running on-premises or distributed in the field. +The Universal Gateway can be used with software running locally or in the cloud, and with devices running on-premises or distributed in the field. You can deliver traffic to internal and public APIs as well as orchestrate traffic across your devices. It's globally distributed by default and provides support across multiple environments with minimal configuration. +## Universal Gateway features + +Here are some of the key features of the Universal Gateway platform: + +- [**Traffic Policy**](/docs/traffic-policy/): filter, match, manage, and orchestrate traffic to your endpoints. +- [**Identity and access management**](/docs/iam/): manage credentials for human users and automated processes. +- [**Traffic observability**](/docs/obs/): capture request and response data; replay requests against your endpoints for debugging replication. +- [**Kubernetes support**](/docs/k8s/): ngrok's Kubernetes Operator supports ingress resources as well as cross-platform Gateway API configuration resources. + ## Common use cases Here are some of the most common use cases for the Universal Gateway, from the [examples collection](/universal-gateway/examples/): @@ -23,42 +32,6 @@ Here are some of the most common use cases for the Universal Gateway, from the [ - [**Secure a public Minecraft server**](/universal-gateway/examples/minecraft/): Restrict server access to a specific set of IP addresses. - [**Intercept and rewrite headers**](/universal-gateway/examples/rewrite-headers-redirects/): Intercept 302 redirect headers to preserve UX and agent behavior. -## Universal Gateway features - -Here are some of the key features of the Universal Gateway platform: - -### Traffic orchestration - -ngrok's Traffic Policy is a configuration language for filtering, matching, managing, and orchestrating traffic to your endpoints. -You can use it to validate incoming traffic, block malicious traffic, rewrite URLs, respond with custom content, and more. - -Learn more in the [Traffic Policy documentation](/docs/traffic-policy/). - -### Kubernetes support - -ngrok's Kubernetes Operator is the best way to build with the Universal Gateway if your applications run in Kubernetes environments. -It comes with custom resources for configuration and also supports both ingress resources as well as cross-platform Gateway API configuration resources. - -You can use the Operator to integrate Kubernetes workloads with workloads outside of Kubernetes, such as those running on virtual machines, bare metal, embedded devices, and anywhere else you can run ngrok. - -Learn more in the [Kubernetes Operator documentation](/docs/obs/). - -### Traffic observability - -The Universal Gateway provides several options for observing the traffic flowing through your endpoints, including the Traffic Inspector and ngrok's event logging system. - -With Traffic Inspector, you can choose to capture full request and response bodies or just metadata, and replay requests against your endpoints for easy debugging replication. -With ngrok's event logging system, you can subscribe to events triggered whenever traffic transits through your endpoints, and publish them to destinations such as AWS Cloudwatch Logs, AWS Firehose, AWS S3, Datadog Logs, and Azure Monitor. - -Learn more in the [traffic observability documentation](/docs/k8s/). - -### Identity and access management - -The Universal Gateway includes a robust identity and access management (IAM) system. -With ngrok's IAM functionality, you can manage credentials for human users and automated processes, record all changes by principal in audit logs, configure single sign-on (SS0), and more. - -Learn more in the [IAM documentation](/docs/iam/). - ## What's next? - Explore key concepts for working with the Universal Gateway such as [endpoint types](/universal-gateway/types/), [protocols](/universal-gateway/protocols/), [bindings](/universal-gateway/bindings/), and [pooling](/universal-gateway/endpoint-pooling/). From 489ba0772262a79920cc0d5a0639e969d4dc9397 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Mon, 21 Jul 2025 12:52:08 -0700 Subject: [PATCH 18/24] order --- docs/universal-gateway/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 877eca33ef..d095e31afb 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -18,8 +18,8 @@ It's globally distributed by default and provides support across multiple enviro Here are some of the key features of the Universal Gateway platform: - [**Traffic Policy**](/docs/traffic-policy/): filter, match, manage, and orchestrate traffic to your endpoints. -- [**Identity and access management**](/docs/iam/): manage credentials for human users and automated processes. - [**Traffic observability**](/docs/obs/): capture request and response data; replay requests against your endpoints for debugging replication. +- [**Identity and access management**](/docs/iam/): manage credentials for human users and automated processes. - [**Kubernetes support**](/docs/k8s/): ngrok's Kubernetes Operator supports ingress resources as well as cross-platform Gateway API configuration resources. ## Common use cases From ed998fec568d674d0e82b5cd220b33b4e1e7ff74 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Mon, 21 Jul 2025 12:57:55 -0700 Subject: [PATCH 19/24] avoid saying across twice in two adjacent sentences --- docs/universal-gateway/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index d095e31afb..7fb349d1a8 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -11,7 +11,7 @@ ngrok's Universal Gateway is a flexible and composable platform for building API **What makes it "universal"?** The Universal Gateway can be used with software running locally or in the cloud, and with devices running on-premises or distributed in the field. You can deliver traffic to internal and public APIs as well as orchestrate traffic across your devices. -It's globally distributed by default and provides support across multiple environments with minimal configuration. +It's globally distributed by default and provides support for multiple environments with minimal configuration. ## Universal Gateway features From 288080814c12bdb7bc39240bc2c947b773c11670 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Tue, 22 Jul 2025 09:08:21 -0700 Subject: [PATCH 20/24] reinforce keyword in headers --- docs/universal-gateway/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 7fb349d1a8..08c4224840 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -22,7 +22,7 @@ Here are some of the key features of the Universal Gateway platform: - [**Identity and access management**](/docs/iam/): manage credentials for human users and automated processes. - [**Kubernetes support**](/docs/k8s/): ngrok's Kubernetes Operator supports ingress resources as well as cross-platform Gateway API configuration resources. -## Common use cases +## Universal Gateway use cases Here are some of the most common use cases for the Universal Gateway, from the [examples collection](/universal-gateway/examples/): From 69159b0ee257c05e485636a54ab0ddec10a3886f Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Mon, 28 Jul 2025 11:11:34 -0700 Subject: [PATCH 21/24] expand scope --- docs/iam/index.mdx | 3 +-- docs/k8s/index.mdx | 3 ++- docs/obs/index.mdx | 3 ++- docs/traffic-policy/concepts/index.mdx | 3 ++- docs/universal-gateway/overview.mdx | 2 +- 5 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/iam/index.mdx b/docs/iam/index.mdx index 13636bbbe9..8aaadaa4ac 100644 --- a/docs/iam/index.mdx +++ b/docs/iam/index.mdx @@ -43,5 +43,4 @@ terminology and concepts ngrok uses to describe its IAM primitives. email address to an Account. - [**RBAC**](/iam/rbac/): Role Base Access Control is used to limit the permissions of what actions a User may take within your account. -- [**Account Domain Controls**](/iam/domain-controls/): Account Domain Controls are used to create - policy on Users who log in or sign up with a given email domain. +- [**Account Domain Controls**](/iam/domain-controls/): Account Domain Controls are used to create policy on Users who log in or sign up with a given email domain. diff --git a/docs/k8s/index.mdx b/docs/k8s/index.mdx index f5caec9654..06d3dcd2c6 100644 --- a/docs/k8s/index.mdx +++ b/docs/k8s/index.mdx @@ -4,7 +4,8 @@ sidebar_label: Overview pagination_next: k8s/how-it-works --- -The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments. It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. When using Kubernetes Ingresses or the Gateway API resources, the ngrok Kubernetes Operator will translate them into managed instances of the ngrok custom resources for you. +The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments. +It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. When using Kubernetes Ingresses or the Gateway API resources, the ngrok Kubernetes Operator will translate them into managed instances of the ngrok custom resources for you. The ngrok Kubernetes Operator is deployed to a cluster and allows developers to self-service endpoints to their apps and services using a shared ngrok account. diff --git a/docs/obs/index.mdx b/docs/obs/index.mdx index 2804a1ea0e..823415b363 100644 --- a/docs/obs/index.mdx +++ b/docs/obs/index.mdx @@ -7,7 +7,8 @@ pagination_next: obs/traffic-inspection # Traffic Observability ngrok provides two powerful mechanisms that allow you to observe and introspect -the network traffic flowing through your Endpoints. An in-dashboard real-time +the network traffic flowing through your Endpoints. +An in-dashboard real-time view of requests and a fully-fledged event system to export events to your own logging systems. diff --git a/docs/traffic-policy/concepts/index.mdx b/docs/traffic-policy/concepts/index.mdx index 10eb07b96e..e2b658d443 100644 --- a/docs/traffic-policy/concepts/index.mdx +++ b/docs/traffic-policy/concepts/index.mdx @@ -7,7 +7,8 @@ pagination_label: Phases # Traffic Policy Overview -The ngrok Traffic Policy engine enables you to manage traffic consistently across your endpoints. It allows you to inspect, manipulate, and route traffic in a structured way. +The ngrok Traffic Policy engine enables you to manage traffic consistently across your endpoints. +It allows you to inspect, manipulate, and route traffic in a structured way. Traffic Policy is composed of a few key components: diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 08c4224840..1c7c253801 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -34,6 +34,6 @@ Here are some of the most common use cases for the Universal Gateway, from the [ ## What's next? -- Explore key concepts for working with the Universal Gateway such as [endpoint types](/universal-gateway/types/), [protocols](/universal-gateway/protocols/), [bindings](/universal-gateway/bindings/), and [pooling](/universal-gateway/endpoint-pooling/). - Check out the [Universal Gateway examples collection](/docs/universal-gateway/examples/) to see how to implement even more common use cases. +- Explore key concepts for working with the Universal Gateway such as [endpoint types](/universal-gateway/types/), [protocols](/universal-gateway/protocols/), [bindings](/universal-gateway/bindings/), and [pooling](/universal-gateway/endpoint-pooling/). - Proceed to the Guides section to get started with ngrok as an [API gateway](/guides/api-gateway/get-started/), [device gateway](/guides/device-gateway/agent/), [identity-aware proxy](/guides/identity-aware-proxy/securing-with-oauth/), or for [site-to-site connectivity](/guides/identity-aware-proxy/securing-with-oauth/). From fbb4da49cb50f2cc271f410783670bb02726be44 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Mon, 28 Jul 2025 11:28:16 -0700 Subject: [PATCH 22/24] clean up existing content --- docs/iam/index.mdx | 18 +++++++++++------- docs/k8s/index.mdx | 15 ++++++++++++--- docs/obs/index.mdx | 22 +++++++--------------- docs/traffic-policy/concepts/index.mdx | 15 ++++++++++++--- docs/universal-gateway/overview.mdx | 4 ++-- 5 files changed, 44 insertions(+), 30 deletions(-) diff --git a/docs/iam/index.mdx b/docs/iam/index.mdx index 8aaadaa4ac..31ef0d955c 100644 --- a/docs/iam/index.mdx +++ b/docs/iam/index.mdx @@ -4,12 +4,8 @@ sidebar_label: Overview pagination_next: iam/users --- -# Identity and Access Management - -## Overview - -ngrok includes a robust identity and access management (IAM) system. ngrok's -IAM functionality enables you to: +ngrok includes a robust identity and access management (IAM) system. +ngrok's IAM functionality enables you to: - Issue, rotate and revoke unique credentials for each principal in your account (either a human user or an automated process). - Enforce least-privilege access for each principal acting within your ngrok account @@ -17,7 +13,7 @@ IAM functionality enables you to: - Configure single sign-on (SSO) to federate identity and SCIM to enable provisioning from your own IdP - Administrate multiple ngrok accounts with a single user -## Concepts +## Features Before diving into ngrok's IAM system, it's helpful to be acquainted with the terminology and concepts ngrok uses to describe its IAM primitives. @@ -44,3 +40,11 @@ terminology and concepts ngrok uses to describe its IAM primitives. - [**RBAC**](/iam/rbac/): Role Base Access Control is used to limit the permissions of what actions a User may take within your account. - [**Account Domain Controls**](/iam/domain-controls/): Account Domain Controls are used to create policy on Users who log in or sign up with a given email domain. + +## Use cases + +TK + +## What's next + +TK \ No newline at end of file diff --git a/docs/k8s/index.mdx b/docs/k8s/index.mdx index 06d3dcd2c6..540c6d95a7 100644 --- a/docs/k8s/index.mdx +++ b/docs/k8s/index.mdx @@ -5,13 +5,18 @@ pagination_next: k8s/how-it-works --- The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments. -It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. When using Kubernetes Ingresses or the Gateway API resources, the ngrok Kubernetes Operator will translate them into managed instances of the ngrok custom resources for you. +It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. +When using Kubernetes Ingresses or the Gateway API resources, the ngrok Kubernetes Operator will translate them into managed instances of the ngrok custom resources for you. The ngrok Kubernetes Operator is deployed to a cluster and allows developers to self-service endpoints to their apps and services using a shared ngrok account. Check out the [how it works](/k8s/how-it-works) and [architecture](/k8s/installation/architecture) pages for more info on how the operator functions. -## When Should I Use The ngrok Kubernetes Operator? +## Features + +TK + +## Use cases You should use the ngrok Kubernetes Operator if you want to: @@ -20,7 +25,7 @@ You should use the ngrok Kubernetes Operator if you want to: 1. Perform cross-cluster networking 1. Use Kubernetes with ngrok without using ngrok's SDKs -## What Type of Config Can I Use With The Operator? +## Configuration The Operator supports its own native custom resource types, including: @@ -42,3 +47,7 @@ controller incur a cost. More details can be found on our [pricing page](https:/ [Kubernetes Ingress docs]: https://kubernetes.io/docs/concepts/services-networking/ingress/ [Gateway API docs]: https://gateway-api.sigs.k8s.io/ + +## What's next + +TK \ No newline at end of file diff --git a/docs/obs/index.mdx b/docs/obs/index.mdx index 823415b363..54ea5db0df 100644 --- a/docs/obs/index.mdx +++ b/docs/obs/index.mdx @@ -4,28 +4,20 @@ sidebar_label: Overview pagination_next: obs/traffic-inspection --- -# Traffic Observability - -ngrok provides two powerful mechanisms that allow you to observe and introspect -the network traffic flowing through your Endpoints. -An in-dashboard real-time -view of requests and a fully-fledged event system to export events to your own -logging systems. +ngrok provides two powerful mechanisms that allow you to observe and introspect the network traffic flowing through your Endpoints. +An in-dashboard real-time view of requests and a fully-fledged event system to export events to your own logging systems. ## Traffic Inspector -Traffic Inspector gives you a view into the HTTP traffic flowing through the -endpoints in your account. You can choose whether Traffic Inspector captures -only request metadata or full request and response bodies. You can even replay -requests against your endpoints for easy debugging replication. +Traffic Inspector gives you a view into the HTTP traffic flowing through the endpoints in your account. +You can choose whether Traffic Inspector captures only request metadata or full request and response bodies. +You can even replay requests against your endpoints for easy debugging replication. [Get Started with Traffic Inspector →](/obs/traffic-inspection/) ## Log Exporting -Whenever changes occur in your ngrok account or when traffic transits through -your endpoints, an event is fired. You may subscribe to these events and -publish them to destinations like AWS Cloudwatch Logs, AWS Firehose, AWS S3, -Datadog Logs, Azure Monitor and more. +Whenever changes occur in your ngrok account or when traffic transits through your endpoints, an event is fired. +You may subscribe to these events and publish them to destinations like AWS Cloudwatch Logs, AWS Firehose, AWS S3, Datadog Logs, Azure Monitor and more. [Get Started with Log Exporting Events →](/obs/events/) diff --git a/docs/traffic-policy/concepts/index.mdx b/docs/traffic-policy/concepts/index.mdx index e2b658d443..b7676537ab 100644 --- a/docs/traffic-policy/concepts/index.mdx +++ b/docs/traffic-policy/concepts/index.mdx @@ -1,15 +1,18 @@ --- sidebar_position: 0 -title: Overview +title: Traffic Policy Overview +sidebar_title: Overview pagination_next: traffic-policy/concepts/phases pagination_label: Phases --- -# Traffic Policy Overview +## What is Traffic Policy? The ngrok Traffic Policy engine enables you to manage traffic consistently across your endpoints. It allows you to inspect, manipulate, and route traffic in a structured way. +## Features + Traffic Policy is composed of a few key components: - [**Phases:**](./phases) Defined points in the traffic lifecycle where you can apply logic. @@ -18,4 +21,10 @@ Traffic Policy is composed of a few key components: - [**Actions:**](./actions) Logic that is triggered when a Phase Rule condition is met. - [**CEL Interpolation:**](./cel-interpolation) A way to dynamically evaluate variables and macros inside configuration values, such as URLs or headers. -By combining these components, Traffic Policy provides a powerful way to control your traffic flow at a fine-grained level. +## Use cases + +TK + +## What's next? + +TK diff --git a/docs/universal-gateway/overview.mdx b/docs/universal-gateway/overview.mdx index 1c7c253801..c23491aeb4 100644 --- a/docs/universal-gateway/overview.mdx +++ b/docs/universal-gateway/overview.mdx @@ -13,7 +13,7 @@ The Universal Gateway can be used with software running locally or in the cloud, You can deliver traffic to internal and public APIs as well as orchestrate traffic across your devices. It's globally distributed by default and provides support for multiple environments with minimal configuration. -## Universal Gateway features +## Features Here are some of the key features of the Universal Gateway platform: @@ -22,7 +22,7 @@ Here are some of the key features of the Universal Gateway platform: - [**Identity and access management**](/docs/iam/): manage credentials for human users and automated processes. - [**Kubernetes support**](/docs/k8s/): ngrok's Kubernetes Operator supports ingress resources as well as cross-platform Gateway API configuration resources. -## Universal Gateway use cases +## Use cases Here are some of the most common use cases for the Universal Gateway, from the [examples collection](/universal-gateway/examples/): From 2b1d2416baf3906453070211b2437e7fe11afeb7 Mon Sep 17 00:00:00 2001 From: SG <212444234+sg-writer@users.noreply.github.com> Date: Mon, 28 Jul 2025 11:54:47 -0700 Subject: [PATCH 23/24] cleanup --- docs/k8s/index.mdx | 2 ++ docs/traffic-policy/concepts/index.mdx | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/k8s/index.mdx b/docs/k8s/index.mdx index 540c6d95a7..68866b315c 100644 --- a/docs/k8s/index.mdx +++ b/docs/k8s/index.mdx @@ -4,6 +4,8 @@ sidebar_label: Overview pagination_next: k8s/how-it-works --- +## What is the Kubernetes Operator? + The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments. It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. When using Kubernetes Ingresses or the Gateway API resources, the ngrok Kubernetes Operator will translate them into managed instances of the ngrok custom resources for you. diff --git a/docs/traffic-policy/concepts/index.mdx b/docs/traffic-policy/concepts/index.mdx index b7676537ab..b1d26c1362 100644 --- a/docs/traffic-policy/concepts/index.mdx +++ b/docs/traffic-policy/concepts/index.mdx @@ -6,7 +6,7 @@ pagination_next: traffic-policy/concepts/phases pagination_label: Phases --- -## What is Traffic Policy? +## What is a Traffic Policy? The ngrok Traffic Policy engine enables you to manage traffic consistently across your endpoints. It allows you to inspect, manipulate, and route traffic in a structured way. From e4ae668f2890165fb8ec86f162d924cc26f56806 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Mon, 28 Jul 2025 18:55:53 +0000 Subject: [PATCH 24/24] ci: apply automated fixes --- docs/iam/index.mdx | 4 ++-- docs/k8s/index.mdx | 6 +++--- docs/obs/index.mdx | 8 ++++---- docs/traffic-policy/concepts/index.mdx | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/iam/index.mdx b/docs/iam/index.mdx index 31ef0d955c..310df93671 100644 --- a/docs/iam/index.mdx +++ b/docs/iam/index.mdx @@ -4,7 +4,7 @@ sidebar_label: Overview pagination_next: iam/users --- -ngrok includes a robust identity and access management (IAM) system. +ngrok includes a robust identity and access management (IAM) system. ngrok's IAM functionality enables you to: - Issue, rotate and revoke unique credentials for each principal in your account (either a human user or an automated process). @@ -47,4 +47,4 @@ TK ## What's next -TK \ No newline at end of file +TK diff --git a/docs/k8s/index.mdx b/docs/k8s/index.mdx index 68866b315c..8ac313618d 100644 --- a/docs/k8s/index.mdx +++ b/docs/k8s/index.mdx @@ -6,8 +6,8 @@ pagination_next: k8s/how-it-works ## What is the Kubernetes Operator? -The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments. -It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. +The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments. +It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. When using Kubernetes Ingresses or the Gateway API resources, the ngrok Kubernetes Operator will translate them into managed instances of the ngrok custom resources for you. The ngrok Kubernetes Operator is deployed to a cluster and allows developers to self-service endpoints to their apps and services using a shared ngrok account. @@ -52,4 +52,4 @@ controller incur a cost. More details can be found on our [pricing page](https:/ ## What's next -TK \ No newline at end of file +TK diff --git a/docs/obs/index.mdx b/docs/obs/index.mdx index 54ea5db0df..bd92a601e2 100644 --- a/docs/obs/index.mdx +++ b/docs/obs/index.mdx @@ -4,20 +4,20 @@ sidebar_label: Overview pagination_next: obs/traffic-inspection --- -ngrok provides two powerful mechanisms that allow you to observe and introspect the network traffic flowing through your Endpoints. +ngrok provides two powerful mechanisms that allow you to observe and introspect the network traffic flowing through your Endpoints. An in-dashboard real-time view of requests and a fully-fledged event system to export events to your own logging systems. ## Traffic Inspector -Traffic Inspector gives you a view into the HTTP traffic flowing through the endpoints in your account. -You can choose whether Traffic Inspector captures only request metadata or full request and response bodies. +Traffic Inspector gives you a view into the HTTP traffic flowing through the endpoints in your account. +You can choose whether Traffic Inspector captures only request metadata or full request and response bodies. You can even replay requests against your endpoints for easy debugging replication. [Get Started with Traffic Inspector →](/obs/traffic-inspection/) ## Log Exporting -Whenever changes occur in your ngrok account or when traffic transits through your endpoints, an event is fired. +Whenever changes occur in your ngrok account or when traffic transits through your endpoints, an event is fired. You may subscribe to these events and publish them to destinations like AWS Cloudwatch Logs, AWS Firehose, AWS S3, Datadog Logs, Azure Monitor and more. [Get Started with Log Exporting Events →](/obs/events/) diff --git a/docs/traffic-policy/concepts/index.mdx b/docs/traffic-policy/concepts/index.mdx index b1d26c1362..79085cf96d 100644 --- a/docs/traffic-policy/concepts/index.mdx +++ b/docs/traffic-policy/concepts/index.mdx @@ -8,7 +8,7 @@ pagination_label: Phases ## What is a Traffic Policy? -The ngrok Traffic Policy engine enables you to manage traffic consistently across your endpoints. +The ngrok Traffic Policy engine enables you to manage traffic consistently across your endpoints. It allows you to inspect, manipulate, and route traffic in a structured way. ## Features