Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mandy/api gw getting started #1014

Merged
merged 11 commits into from
Oct 30, 2024
Merged
641 changes: 641 additions & 0 deletions docs/guides/api-gateway/get-started.mdx

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/api-gateway/img/auth0-create-api.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/api-gateway/img/auth0-test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/api-gateway/img/bot-authtoken.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/api-gateway/img/bot-user.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/api-gateway/img/reserve-domain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/guides/api-gateway/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ This section provides guides for using ngrok as an API Gateway.

| Name | Description |
| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| [Deliver and secure APIs in production](get-started.mdx) | Get started using ngrok to deliver and secure APIs in production |
| [Deliver and secure ingress for APIs in Kubernetes](kubernetes.mdx) | Deploy ngrok's Kubernetes Operator onto your cluster for unified ingress and advanced traffic shaping with K8s-native interfaces |
2 changes: 1 addition & 1 deletion docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Here you will find a set of guides to help you with common (and not so common) t

| Name | Description |
| :----------------------------------------------------- | :-------------------------------------------------- |
| [API gateway](/guides/api-gateway) | Deploy ngrok as an API gateway to upstream services |
| [API Gateway](/guides/api-gateway) | Deploy ngrok as an API gateway to upstream services |
| [Device Gateway](/guides/device-gateway) | Use ngrok as a device gateway |
| [Identity-Aware Proxy](identity-aware-proxy) | Configure ngrok for use as an identity-aware proxy |
| [Site-to-Site Connectivity](site-to-site-connectivity) | Connect to remote sites with ngrok |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To follow this guide, you will need a local computer with `ngrok` installed. [Yo

If you are going to be following along using the **ngrok CLI**, you will need:

- An [ngrok API key](https://dashboard.ngrok.com/api) configured on your [ngrok agent](https://ngrok.com/docs/ngrok-agent/ngrok/#ngrok-api).
- An [ngrok API key](https://dashboard.ngrok.com/api) configured on your [ngrok agent](/docs/agent/#api-keys).

If you are going to be following along using **CURL**, you will need:

Expand Down Expand Up @@ -67,7 +67,7 @@ For the purpose of this guide, we will create a ngrok HTTP domain.

```bash
ngrok api reserved-domains create \
--url ${NGROK_SUBDOMAIN}.ngrok.app
--domain ${NGROK_SUBDOMAIN}.ngrok.app
```

- Replace or set `${NGROK_SUBDOMAIN}` as the subdomain you'd like to use for this guide.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ JWT.
## Step 2 — Accessing your JWT

Upon creating your new API, Auth0 will create an associated application under
`Applications > Applications` in the left navigation bar.
`Applications > APIs` in the left navigation bar.

Navigate to your application, and click on the `Quickstart` tab. Here, you will
find a signed, fully functional JWT, as well as examples of progromatically
generating more in multiple languages.
Navigate to your application, and click on the `Test` tab. Here, you will
find a signed, fully functional JWT, as well as examples of how to programmatically
generate one.

![Auth0 Quickstart JWT](img/auth0-quickstart.png)
![Auth0 Test JWT](img/auth0-test.png)

## Step 3 — Creating a Machine to Machine application

Expand Down