Skip to content

Commit

Permalink
add inline code highlights and updated copy-text
Browse files Browse the repository at this point in the history
  • Loading branch information
@KristopherPaulsen
KristopherPaulsen committed Sep 9, 2024
1 parent 9aaf3ec commit 30d5b36
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/agent/config/v3.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ The following is a list of fields nested under `agent` in your configuration fil
| [update_channel](#update_channel) | The update channel determines the stability of released builds to update to. Use `stable` for all production deployments. |
| [update_check](#update_check) | This tells the ngrok agent if it should check for updates. Defaults to `true`. |
| [web_addr](#web_addr) | Network address to bind on for serving the local web interface and api. |
| [web_allow_hosts](#web_allow_hosts) | Host headers to allow access for on the local web interface and api, can be a combination of IP's, CIDR ranges, and/or hostname suffixes. |
| [web_allow_hosts](#web_allow_hosts) | `Host` headers to allow access for on the local web interface and api, can be a combination of IP's, CIDR ranges, and/or hostname suffixes. |

### `api_key`

Expand Down Expand Up @@ -450,19 +450,19 @@ This is the network address to bind on for serving the local agent web interface

### `web_allow_hosts`

These are a list of specifiers for what Host headers will be allowed to make requests agains the local agent web interface and API. Any port is stripped off the Host header before matching is performed.
These are a list of specifiers for what `Host` headers will be allowed to make requests agains the local agent web interface and API. Any port is stripped off the `Host` header before matching is performed.

| Allow string | | Example Host headers that would match |
| ------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| | default | requests to localhost-bound web interface or API endpoints are checked to have a localhost-like Host (localhost, 127.0.0.1, ::1, etc.) |
| 8.8.8.8 | | an IP matches Host header (8.8.8.8) |
| 1:2:3:4:5:6:7:8 | | an IPv6 matches Host header (1:2:3:4:5:6:7:8) |
| 10.0.0.0/8 | | a CIDR range matches a Host header that is an IP address in that range (10.0.0.1 or 10.1.2.3) |
| 1:2:3:4:5:6:7:8/16 | | a CIDR range matches a Host header that is an IPv6 address in that range (1:2:3:4:5:6:7:0) |
| example.com | | a hostname without preceding period will match Host header exactly (example.com) |
| .example.com | | a hostname with a preceding period Host header suffix (sub.example.com or foo.example.com) |
| Allow string | | Example `Host` headers that would match |
| ------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| | default | requests to localhost-bound web interface or API endpoints are checked to have a localhost-like `Host` (localhost, 127.0.0.1, ::1, etc.) |
| 8.8.8.8 | | an IP matches `Host` header (8.8.8.8) |
| 1:2:3:4:5:6:7:8 | | an IPv6 matches `Host` header (1:2:3:4:5:6:7:8) |
| 10.0.0.0/8 | | a CIDR range matches a `Host` header that is an IP address in that range (10.0.0.1 or 10.1.2.3) |
| 1:2:3:4:5:6:7:8/16 | | a CIDR range matches a `Host` header that is an IPv6 address in that range (1:2:3:4:5:6:7:0) |
| example.com | | a hostname without preceding period will match `Host` header exactly (example.com) |
| .example.com | | a hostname with a preceding period `Host` header suffix (sub.example.com or foo.example.com) |

##### Allow an IP address and a Domain as Host headers
##### Allow an IP address and a domain as `Host` headers

```yaml
agent:
Expand Down

0 comments on commit 30d5b36

Please sign in to comment.