Skip to content

Commit

Permalink
update as per review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
KristopherPaulsen committed Sep 9, 2024
1 parent 0b5e22d commit 823cdc4
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/agent/config/v3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Version 3"
## Breaking Changes

- [Agent specific fields](/docs/agent/config/v3/#agent-configuration) are no longer top level-keys, but instead nested under the **required** `agent:` field.
- There are now _4_ top-level keys (`version`, `agent`, `endpoints`, and `tunnels`.)
- There are now four top-level keys: `version`, `agent`, `endpoints`, and `tunnels`.
- `tunnels` are deprecated in favor of `endpoints`.

```yaml
Expand All @@ -18,11 +18,11 @@ endpoints: ...
tunnels: # deprecated
```
_For a complete list of `agent:` related fields, checkout [agent configuration](/docs/agent/config/v3/#agent-configuration)._
For a complete list of `agent:` related fields, checkout [agent configuration](/docs/agent/config/v3/#agent-configuration).

## Example Configs
## Example Configuration Files

Below are a collection of different agent configurations to serve as examples for your `ngrok.yml` file. _See [agent configuration](/docs/agent/config/v3/#agent-configuration) for more details on starting [individual](#start-the-endpoint-named-httpbin) or [all](/docs/agent/config/v3/#start-all-endpoints-defined-in-the-configuration-file) config defined endpoints from the CLI._
Below are a collection of different agent configurations to serve as examples for your `ngrok.yml` file. The [next section](/docs/agent/config/v3/#endpoint-configurations) explains how to start some or all of your configured endpoints from the CLI.

### Basic

Expand All @@ -37,7 +37,7 @@ endpoints:
url: 8080
```

### Multiple Endpoints
### Multiple endpoints

```yaml
version: 3
Expand Down

0 comments on commit 823cdc4

Please sign in to comment.