Skip to content

Commit

Permalink
Update v3.mdx (#1003)
Browse files Browse the repository at this point in the history
Resolves ngrok-private/ngrok#33865

Update example and url for endpoints to include TCP and TLS.
  • Loading branch information
justngrok authored Oct 30, 2024
1 parent 71f610f commit a929e2e
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions docs/agent/config/v3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ endpoint configuration options can be found here.

### Example

In the snippet below we are defining two endpoints named 'httpbin' and 'demo':
In the snippet below we are defining two HTTPS endpoints, one TCP endpoint, and one TLS endpoint named 'httpbin', 'demo', 'ssh', and 'demo-2':

```yaml
endpoints:
Expand All @@ -328,6 +328,14 @@ endpoints:
url: https://demo.inconshreveable.com
upstream:
url: 8181
- name: ssh
url: tcp://1.tcp.ngrok.io:12345
upstream:
url: 22
- name: demo-2
url: tls://myexample.ngrok.app
upstream:
url: 443
```

#### Start the endpoint named 'httpbin'
Expand Down Expand Up @@ -379,9 +387,9 @@ String. The address you would like to use to forward traffic to your upstream se

- **Domain** - `example.org`
- When using the _domain_ format you are only defining the domain. The scheme and port will be inferred.
- **Origin** - `https://example.ngrok.app` _or_ `https://example.ngrok.app:443`
- When using the _origin_ format you are defining the protocol, domain and port.
- **Scheme (shorthand)** - `https://`
- **Origin** - `https://example.ngrok.app` _or_ `https://example.ngrok.app:443` _or_ `tcp://1.tcp.ngrok.io:12345` _or_ `tls://example.ngrok.app`
- When using the _origin_ format you are defining the protocol, domain and port. HTTP endpoints accept ports `80` or `443` with respective protocol.
- **Scheme (shorthand)** - `https://` _or_ `tcp://` _or_ `tls://` _or_ `http://`
- When using _scheme_ you are defining the protocol and will receive back a randomly assigned ngrok address.
- **Empty** - ``
- When _empty_ your endpoint will default to be `https` and receive back a randomly assigned ngrok address.
Expand Down

0 comments on commit a929e2e

Please sign in to comment.