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.

Sign up for GitHub

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

WIP: Traffic Policy module docs #561

Merged
merged 67 commits into from
Feb 16, 2024
Merged

WIP: Traffic Policy module docs #561

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
b84142f
automated generation of docs from buildkite
Jan 31, 2024
cb56c04
starting to piece together some documentation scaffolding for http en…
rkolavo Jan 17, 2024
ebcf8b3
more examples, copypasta to tcp/tls
rkolavo Jan 17, 2024
614e4b8
prettier
rkolavo Jan 17, 2024
7c538e3
rename to traffic policy
rkolavo Jan 19, 2024
43819bd
more examples + rewording
rkolavo Jan 22, 2024
6711872
sidebar for api changes
rkolavo Jan 22, 2024
f051f28
prettier
rkolavo Jan 22, 2024
1b81a2b
Add log details
rkolavo Jan 22, 2024
56e6a84
feat: add expressions header and move macro examples out of the table
nijikokun Jan 22, 2024
a2a1e69
fix: prettier
nijikokun Jan 22, 2024
c57ad26
feat: clean up expressions docs for TLS/TCP/HTTP
nijikokun Jan 22, 2024
eb2752a
remove rate-limiting from tcp/tls
rkolavo Jan 22, 2024
2711657
prettier
rkolavo Jan 22, 2024
b1158b3
incorporate url-rewrite doc, cleanup/rename
rkolavo Jan 30, 2024
84c54b9
prettier
rkolavo Jan 31, 2024
4a2d565
fix sidebar for renamed pages
rkolavo Jan 31, 2024
1d4315e
more renames
rkolavo Jan 31, 2024
abcebef
formatting and adding rate limit details
rkolavo Jan 31, 2024
e4f12a7
rate limiting docs
natasha-jarus Jan 31, 2024
bd3f1f5
--policy-config is --policy-file
rkolavo Feb 1, 2024
cb4cc25
feat: add action config examples
nijikokun Feb 2, 2024
d04d36a
go sdk examples
rkolavo Feb 2, 2024
984c62d
tabify
rkolavo Feb 2, 2024
291bc3a
add python examples, prettierrrrr
rkolavo Feb 2, 2024
709ea6d
Add policy action doc (#582)
wdawson Feb 6, 2024
116e290
feat(traffic-policy): use configexample for expressions
nijikokun Feb 6, 2024
95c62e6
docs(jwt): add JWKS definition
nijikokun Feb 6, 2024
22c31dc
docs(jwt): teh -> the
nijikokun Feb 6, 2024
ebc138f
docs(traffic-policy): use configexample for expressions
nijikokun Feb 6, 2024
5200655
update macros examples
benjaminchan Feb 6, 2024
b7e4d59
update go-sdk examples, add javascript and k8s examples
rkolavo Feb 7, 2024
84da0ca
more k8s examples
rkolavo Feb 7, 2024
2578b1b
feat: adding jwt action guide for auth0
russorat Feb 9, 2024
525be48
fix: example typo
russorat Feb 9, 2024
8560c28
fix: addressing pr comments
russorat Feb 9, 2024
c883879
fix: addressing more pr comments
russorat Feb 9, 2024
43745b7
fix: use yaml for json
nijikokun Feb 13, 2024
dfa8fd1
feat: add rule gallery for http, various fixes
nijikokun Feb 13, 2024
7c5c412
custom-response: update configuration (#598)
TheConcierge Feb 14, 2024
d9200a6
chore: update docs for rate-limit action
nijikokun Feb 14, 2024
b762005
fix: check against nil
nijikokun Feb 15, 2024
c312334
fix: check len
nijikokun Feb 15, 2024
b9937cb
fix: use size
nijikokun Feb 15, 2024
d02a49b
fix: not in
nijikokun Feb 15, 2024
1733c7a
add documentation for cidr macros (#599)
benjaminchan Feb 16, 2024
8e8e69b
docs(agent): changelog for 3.6.0 (#581)
nijikokun Feb 7, 2024
214fecc
Adding 3.6 to version support policy
salilsub Feb 7, 2024
9691a2a
Fixing reversion on the docs
salilsub Feb 8, 2024
e8aca35
Create limits guide
samcrichard Feb 6, 2024
adbfa94
Update limits
samcrichard Feb 6, 2024
500b903
fix: clean up and adding to guide index
russorat Feb 8, 2024
b1f4d0a
fix: broken link
russorat Feb 8, 2024
68c6c2a
Update limits.md
samcrichard Feb 8, 2024
7680b9b
runs fmt
cody-dot-js Feb 8, 2024
b6da1b3
Adding links to the setup and installation pages in the dashboard
salilsub Feb 5, 2024
8f295f3
Add integration how-to guide: Ingress to apps deployed on Azure Kuber…
joelhans Feb 9, 2024
620472a
Update limits.md
samcrichard Feb 9, 2024
38a93dd
feat: initial traffic inspector docs
russorat Feb 9, 2024
ff99574
Fixing broken link
salilsub Feb 12, 2024
d0cb906
Remove JWT Validation Module entirely because docs pipeliene doesn't.…
wdawson Feb 13, 2024
b287444
feat: adding orb to webhook verification
russorat Feb 15, 2024
60aa101
feat: initial whats new
russorat Feb 3, 2024
7158ff3
feat: adding whats new page
russorat Feb 10, 2024
1983e49
fix: adding more stuff
russorat Feb 15, 2024
1b745cd
fix: fmt
russorat Feb 15, 2024
2ac863c
Merge branch 'main' into rk/policy-module-docs
nijikokun Feb 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
101 changes: 52 additions & 49 deletions docs/agent/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,42 +381,43 @@ ngrok http https://localhost:8443 # forward to a local https server

### Flags

| Flag | Description |
| ---------------------------------- | ------------------------------------------------------------------------------------------------- |
| `--authtoken string` | ngrok authtoken |
| `--app-protocol string` | specify the application protocol to be used: `http1`, `http2` (default `http1`) |
| `--basic-auth strings` | enforce basic auth on tunnel endpoint, `user:password` |
| `--cidr-allow strings` | reject connections that do not match the given CIDRs |
| `--cidr-deny strings` | reject connections that match the given CIDRs |
| `--circuit-breaker float` | reject requests when 5XX responses exceed this ratio |
| `--compression` | gzip compress http responses from your web service |
| `--config strings` | path to config files; they are merged if multiple |
| `--domain string` | host tunnel on a custom domain |
| `-h`, `--help` | help for this command |
| `--host-header string` | set Host header; if `rewrite` use local address hostname |
| `--inspect` | enable/disable http introspection (default true) |
| `--log string` | path to log file, `stdout`, `stderr` or `false` (default `false`) |
| `--log-format string` | log record format: `term`, `logfmt`, `json` (default `term`) |
| `--log-level string` | logging level: `debug`, `info`, `warn`, `error`, `crit` (default `info`) |
| `--mutual-tls-cas string` | path to TLS certificate authority to verify client certs in mutual TLS. |
| `--oauth string` | enforce authentication OAuth2 provider on tunnel endpoint, e.g. `google` |
| `--oauth-allow-domain strings` | allow only OAuth2 users with these email domains |
| `--oauth-allow-email strings` | allow only OAuth2 users with these emails |
| `--oauth-client-id string` | oauth app client id, optional |
| `--oauth-client-secret string` | oauth app client id, optional |
| `--oauth-scope strings` | request these OAuth2 scopes when users authenticate |
| `--proxy-proto string` | version of PROXY protocol to use with this tunnel, empty if not using. Example values are 1 or 2. |
| `--region string` | ngrok server region `us`, `us-cal-1`, `eu`, `au`, `ap`, `sa`, `jp`, `in` (defaults to closest) |
| `--request-header-add strings` | header key:value to add to request |
| `--request-header-remove strings` | header field to remove from request if present |
| `--response-header-add strings` | header key:value to add to response |
| `--response-header-remove strings` | header field to remove from response if present |
| `--scheme strings` | which scheme to listen on (default `https`) |
| `--ua-filter-allow strings` | a list of regular expressions for user-agents to allow |
| `--ua-filter-deny strings` | a list of regular expressions for user-agents to deny |
| `--verify-webhook string` | validate webhooks are signed by this provider, e.g. `slack` |
| `--verify-webhook-secret string` | secret used by provider to sign webhooks, if any |
| `--websocket-tcp-converter` | convert ingress websocket connections to TCP upstream |
| Flag | Description |
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `--authtoken string` | ngrok authtoken |
| `--app-protocol string` | specify the application protocol to be used: `http1`, `http2` (default `http1`) |
| `--basic-auth strings` | enforce basic auth on tunnel endpoint, `user:password` |
| `--cidr-allow strings` | reject connections that do not match the given CIDRs |
| `--cidr-deny strings` | reject connections that match the given CIDRs |
| `--circuit-breaker float` | reject requests when 5XX responses exceed this ratio |
| `--compression` | gzip compress http responses from your web service |
| `--config strings` | path to config files; they are merged if multiple |
| `--domain string` | host tunnel on a custom domain |
| `-h`, `--help` | help for this command |
| `--host-header string` | set Host header; if `rewrite` use local address hostname |
| `--inspect` | enable/disable http introspection (default true) |
| `--log string` | path to log file, `stdout`, `stderr` or `false` (default `false`) |
| `--log-format string` | log record format: `term`, `logfmt`, `json` (default `term`) |
| `--log-level string` | logging level: `debug`, `info`, `warn`, `error`, `crit` (default `info`) |
| `--mutual-tls-cas string` | path to TLS certificate authority to verify client certs in mutual TLS. |
| `--oauth string` | enforce authentication OAuth2 provider on tunnel endpoint, e.g. `google` |
| `--oauth-allow-domain strings` | allow only OAuth2 users with these email domains |
| `--oauth-allow-email strings` | allow only OAuth2 users with these emails |
| `--oauth-client-id string` | oauth app client id, optional |
| `--oauth-client-secret string` | oauth app client id, optional |
| `--oauth-scope strings` | request these OAuth2 scopes when users authenticate |
| `--policy-file string` | path to traffic policy configuration YAML file (See [Traffic Policy](/http/traffic-policy/?cty=agent-cli)) |
| `--proxy-proto string` | version of PROXY protocol to use with this tunnel, empty if not using. Example values are 1 or 2. |
| `--region string` | ngrok server region `us`, `us-cal-1`, `eu`, `au`, `ap`, `sa`, `jp`, `in` (defaults to closest) |
| `--request-header-add strings` | header key:value to add to request |
| `--request-header-remove strings` | header field to remove from request if present |
| `--response-header-add strings` | header key:value to add to response |
| `--response-header-remove strings` | header field to remove from response if present |
| `--scheme strings` | which scheme to listen on (default `https`) |
| `--ua-filter-allow strings` | a list of regular expressions for user-agents to allow |
| `--ua-filter-deny strings` | a list of regular expressions for user-agents to deny |
| `--verify-webhook string` | validate webhooks are signed by this provider, e.g. `slack` |
| `--verify-webhook-secret string` | secret used by provider to sign webhooks, if any |
| `--websocket-tcp-converter` | convert ingress websocket connections to TCP upstream |

## ngrok service

Expand Down Expand Up @@ -507,19 +508,20 @@ ngrok tcp --remote-addr=1.tcp.ngrok.io:27210 3389

### Flags

| Flag | Description |
| ---------------------- | --------------------------------------------------------------------------------------------- |
| `--authtoken string` | ngrok authtoken |
| `--cidr-allow strings` | reject connections that do not match the given CIDRs |
| `--cidr-deny strings` | reject connections that match the given CIDRs |
| `--config strings` | path to config files; they are merged if multiple |
| `-h`, `--help` | help for this command |
| `--log string` | path to log file, `stdout`, `stderr` or `false` (default `false`) |
| `--log-format string` | log record format: `term`, `logfmt`, `json` (default `term`) |
| `--log-level string` | `debug`, `info`, `warn`, `error`, `crit` (default `info`) |
| `--proxy-proto string` | version of proxy proto to use with this tunnel, empty if not using |
| `--region string` | ngrok server region `us`, `us-cal-1`, `eu`, `au`, `ap`, `sa`, `jp`, `in` (default to closest) |
| `--remote-addr string` | bind remote address (requires you reserve a TCP Address) |
| Flag | Description |
| ---------------------- | --------------------------------------------------------------------------------------------------------- |
| `--authtoken string` | ngrok authtoken |
| `--cidr-allow strings` | reject connections that do not match the given CIDRs |
| `--cidr-deny strings` | reject connections that match the given CIDRs |
| `--config strings` | path to config files; they are merged if multiple |
| `-h`, `--help` | help for this command |
| `--log string` | path to log file, `stdout`, `stderr` or `false` (default `false`) |
| `--log-format string` | log record format: `term`, `logfmt`, `json` (default `term`) |
| `--log-level string` | `debug`, `info`, `warn`, `error`, `crit` (default `info`) |
| `--policy-file string` | path to traffic policy configuration YAML file (See [Traffic Policy](/tcp/traffic-policy/?cty=agent-cli)) |
| `--proxy-proto string` | version of proxy proto to use with this tunnel, empty if not using |
| `--region string` | ngrok server region `us`, `us-cal-1`, `eu`, `au`, `ap`, `sa`, `jp`, `in` (default to closest) |
| `--remote-addr string` | bind remote address (requires you reserve a TCP Address) |

## ngrok tls

Expand Down Expand Up @@ -568,6 +570,7 @@ ngrok tls --domain=t.co --crt=/path/to/t.co.crt --key=/path/to/t.co.key 443
| `--log-format string` | log record format: `term`, `logfmt`, `json` (default `term`) |
| `--log-level string` | `debug`, `info`, `warn`, `error`, `crit` (default `info`) |
| `--mutual-tls-cas string` | path to TLS certificate authority to verify client certs in mutual TLS |
| `--policy-file string` | path to traffic policy configuration YAML file (See [Traffic Policy](/tls/traffic-policy/?cty=agent-cli)) |
| `--proxy-proto string` | version of proxy proto to use with this tunnel, empty if not using |
| `--region string` | ngrok server region `us`, `us-cal-1`, `eu`, `au`, `ap`, `sa`, `jp`, `in` (defaults to closest) |
| `--terminate-at string` | terminate at ngrok "edge", "agent" or "upstream. Defaults to no termination or "edge" if `--crt` or `--key` are present |
Expand Down
Loading
Loading