Universal Gateway Examples
Whether you need an API gateway, multicloud failover, or want to integrate ngrok with your stack, these examples help you compose endpoints and to orchestrate traffic for common jobs to be done and problems to be solve. Wire it up, secure it, and ship it already.
Fundamentals
Implement the 'Front Door' Pattern
By using a Cloud Endpoint and internal Agent Endpoints together, you loosely couple your gateway and services for extra flexibility.
Multiplex to Internal Services from a Single Domain
Dynamically serve any number of API or web app services from a single fully qualified domain name (FQDN) without complex networking configurations.
Deploy Custom Error Pages
Instead of a blank page or HTTP error code, ensure your services automatically failover to error pages with clear details and instructions.
Production Gateways
Distribute Traffic Between Canary Deployments
Use ngrok to validate how features or versions of your services behave by distributing production traffic randomly or via a specific header.
Switch Traffic Between Blue-Green Deployments
Test two production environments, either for monolithic or microservices architectures, side-by-side with a testing header and instant rollouts/rollbacks.
Use ngrok with...
Accelerate and Secure Your Wordpress Installation
Improve your existing Wordpress installation with automatic TLS certificates, global load balancing, DDoS protection, and options to protect your admin dashboard.
Offload Analytics to a Secondary Service
Capture observability data from your gateway and send it to a self-hosted analytics service securely and without instrumenting your code.
Validate Requests Against an Internal Identity Service
Enrich your upstream service with customer details, use other authentication methods, and simplify DX by adding identity logic to your gateway through an HTTP request.
Apply Rate Limits (Pre-Tiering) Based on Identity or CRM Services
Use existing customer data and your service's pricing model to apply the proper rate limit to a user's IP address.
Expose and Secure Your Self-Hosted Ollama API
Use ngrok to create a public endpoint for your local LLM, enabling remote access and integration, while also adding authentication and access control.
Expose and Secure Your Self-Hosted n8n Workflows
Get your n8n instance online to share with colleagues or receive webhook data with security measures desinged for production usage.
Secure Your Public Minecraft Server
Unwanted players can quickly destroy your hard work, but you can restrict access by letting in a specific set of IP addresses.
Traffic Control
Route to Endpoints by Geography
Show users content based on their region, comply with regulations, or ensure traffic hits the nearest endpoint for the lowest latency.
Deploy a Zero-Code Maintenance Mode for Your Services
Deploy a consistent maintenance message for your services without having to spin up new services or make changes to your network.
Authentication & Authorization
Lock Down Your Admin Dashboards
Add multiple layers of protection and authentication to your dashboards to prevent threat actors from even attempting attacks.
Authenticate and Route API vs. App Traffic Based on User Agent
Automatically enforce the right type of AuthN and route requests to the appropriate upstream service from the same hostname and path.
Route to Services Based on OIDC Authentication
Use the data returned by your OIDC provider to route authenticated requsets to specific upstream services.
Enforce IP Restrictions or JWT Validation
Support multiple ways for your users to connect to upstream services with a flexible OR operator pattern.