Skip to content

Commit d842186

Browse files
sg-writersg-writer
committed
Restore deleted files
1 parent b76bd07 commit d842186

File tree

4 files changed

+146
-0
lines changed

4 files changed

+146
-0
lines changed

‎iam/index.mdx‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Identity and Access Management
3+
sidebarTitle: IAM
4+
---
5+
6+
## Overview
7+
8+
ngrok includes a robust identity and access management (IAM) system. ngrok's
9+
IAM functionality enables you to:
10+
11+
- Issue, rotate and revoke unique credentials for each principal in your account (either a human user or an automated process).
12+
- Enforce least-privilege access for each principal acting within your ngrok account
13+
- Attribute all mutations to distinct principals in your ngrok account recorded in audit logs
14+
- Configure single sign-on (SSO) to federate identity and SCIM to enable provisioning from your own IdP
15+
- Administrate multiple ngrok accounts with a single user
16+
17+
## Concepts
18+
19+
Before diving into ngrok's IAM system, it's helpful to be acquainted with the
20+
terminology and concepts ngrok uses to describe its IAM primitives.
21+
22+
- **Accounts**: ngrok Accounts are the containers in which you create and consume ngrok services.
23+
- [**Users**](/iam/users/): An Account contains one or more **Users**. Users are members of
24+
the Account who can take actions within it, like creating objects, start agents
25+
or making API requests. Users may be members of multiple accounts and are not owned by any single account.
26+
- [**Service Users**](/iam/service-users): Accounts also contain **Service Users** which are like Users but
27+
meant to be used for automated processes. Other systems may call these 'Service
28+
Accounts'.
29+
- [**Principals**](/obs/events/#principal-object): A principal is either a User or Service User. Principals are
30+
members of an Account that may take actions inside of it.
31+
- [**Credentials**](/iam/users/#credentials): These are the keys and tokens that Principals use to
32+
authenticate with the ngrok service. Types of Credential include Authtokens,
33+
API Keys, and SSH Public Keys.
34+
- [**Authtokens**](/agent/#authtokens): Principals begin Agent sessions and create Endpoints by
35+
authenticating with Authtoken.
36+
- [**API Keys**](/api/#authentication): Principals make API Requests by authenticating with an API Key.
37+
- [**SSH Public Keys**](/agent/ssh-reverse-tunnel-agent/#authentication): Principals create Endpoints via the SSH Reverse Tunnel
38+
Agent with an SSH Public Key.
39+
- [**Invitations**](/iam/users/#invitations): Invitations are a mechanism to add a new User with a given
40+
email address to an Account.
41+
- [**RBAC**](/iam/rbac/): Role Base Access Control is used to limit the permissions of what
42+
actions a User may take within your account.
43+
- [**Account Domain Controls**](/iam/domain-controls/): Account Domain Controls are used to create
44+
policy on Users who log in or sign up with a given email domain.

‎obs/index.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Traffic Observability
3+
sidebarTitle: Overview
4+
---
5+
6+
ngrok provides two powerful mechanisms that allow you to observe and introspect
7+
the network traffic flowing through your Endpoints. An in-dashboard real-time
8+
view of requests and a fully-fledged event system to export events to your own
9+
logging systems.
10+
11+
## Traffic Inspector
12+
13+
Traffic Inspector gives you a view into the HTTP traffic flowing through the
14+
endpoints in your account. You can choose whether Traffic Inspector captures
15+
only request metadata or full request and response bodies. You can even replay
16+
requests against your endpoints for easy debugging replication.
17+
18+
[Get Started with Traffic Inspector →](/obs/traffic-inspection/)
19+
20+
## Log Exporting
21+
22+
Whenever changes occur in your ngrok account or when traffic transits through
23+
your endpoints, an event is fired. You may subscribe to these events and
24+
publish them to destinations like AWS Cloudwatch Logs, AWS Firehose, AWS S3,
25+
Datadog Logs, Azure Monitor and more.
26+
27+
[Get Started with Log Exporting Events →](/obs/events/)

‎traffic-policy/concepts/index.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Traffic Policy Concepts
3+
sidebarTitle: Overview
4+
description: Learn about the key concepts of ngrok's Traffic Policy engine.
5+
---
6+
7+
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.
8+
9+
Traffic Policy is composed of a few key components:
10+
11+
- [**Phases:**](/traffic-policy/concepts/phases) Defined points in the traffic lifecycle where you can apply logic.
12+
- [**Phase Rules:**](/traffic-policy/concepts/phase-rules) The set of conditions and actions applied during specific phases to filter, manipulate, or manage traffic.
13+
- [**Expressions:**](/traffic-policy/concepts/expressions) Conditions used in Phase Rules to determine when an action should be applied.
14+
- [**Actions:**](/traffic-policy/concepts/actions) Logic that is triggered when a Phase Rule condition is met.
15+
- [**CEL Interpolation:**](/traffic-policy/concepts/cel-interpolation) A way to dynamically evaluate variables and macros inside configuration values, such as URLs or headers.
16+
17+
By combining these components, Traffic Policy provides a powerful way to control your traffic flow at a fine-grained level.

‎universal-gateway/overview.mdx‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Universal Gateway Overview
3+
sidebarTitle: Overview
4+
---
5+
6+
ngrok's Universal Gateway is a suite of common tools for building API and device gateways, identity-aware proxies, and site-to-site connectivity.
7+
It secures, accelerates, and protects your applications.
8+
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/).
9+
10+
## Concepts
11+
12+
Dive into the different parts of the Universal Gateway like Endpoints, Bindings, Pools, and Domains to understand how they work.
13+
14+
Learn more about Universal Gateway Concepts:
15+
16+
- [Domains →](/universal-gateway/domains/)
17+
- [TCP Addresses →](/universal-gateway/tcp-addresses/)
18+
- [TLS Certificates →](/universal-gateway/tls-certificates/)
19+
- [Edges →](/universal-gateway/edges/)
20+
21+
## Endpoints
22+
23+
[Endpoints](/universal-gateway/endpoints/) are how ngrok enables traffic to reach your services.
24+
25+
Learn more about Endpoints:
26+
27+
- [Bindings →](/universal-gateway/bindings/)
28+
- [Internal Endpoints →](/universal-gateway/internal-endpoints/)
29+
- [Public Endpoints →](/universal-gateway/public-endpoints/)
30+
- [Kubernetes Endpoints →](/universal-gateway/kubernetes-endpoints/)
31+
32+
## Load Balancing
33+
34+
Endpoints Pools make load balancing dead simple.
35+
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.
36+
37+
- [Learn more about Load Balancing with Endpoint Pools →](/universal-gateway/endpoint-pooling/)
38+
39+
## TLS
40+
41+
ngrok automatically handles TLS (SSL) termination and certificate management for you.
42+
There is typically nothing to setup, configure, or manage.
43+
44+
- [Learn more about TLS Certificates →](/universal-gateway/tls-certificates/)
45+
- [Learn more about the TLS Termination →](/universal-gateway/tls-termination/)
46+
47+
## Global Load Balancer
48+
49+
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.
50+
51+
- [Learn more about the Global Load Balancer →](/universal-gateway/global-load-balancer/)
52+
- [See ngrok's Global Points of Presence →](/universal-gateway/points-of-presence)
53+
54+
## DDoS Protection
55+
56+
ngrok automatically protects your applications with out-of-the-box protection from distributed denial-of-service (DDoS) attacks.
57+
58+
- [Learn more about DDoS Protection →](/universal-gateway/ddos-protection)

0 commit comments

Comments
 (0)