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

Jump to bottom

fix: remove server addr from v3 docs #915

Closed
wants to merge 3 commits into from
Closed

fix: remove server addr from v3 docs #915

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dd94f40
fix: remove server addr from v3 docs
russorat Aug 29, 2024
3cc61a3
fix: add additional space for items under the agent section
russorat Aug 30, 2024
2d6164d
ci: apply automated fixes
autofix-ci[bot] Aug 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 26 additions & 38 deletions docs/agent/config/v3.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,16 @@ agent:
# | API Key |
# ----------------------------------------------------------------------

# The ngrok API key used to connect to the ngrok API.
# The ngrok API key used to connect to the ngrok API. This is nested in
# the agent
#
# (!) This is only needed when using the ngrok api command and should
# not be confused with the authtoken.
#
# (1) You can obtain and manage your API Keys through the dashboard:
# https://dashboard.ngrok.com/api-keys

# api_key: 24yRd5U3DestCQapJrrVHLOqiAC_7RviwRqpd3wc9dKLujQZN
# api_key: 24yRd5U3DestCQapJrrVHLOqiAC_7RviwRqpd3wc9dKLujQZN

# ----------------------------------------------------------------------
# | Connect Timeout |
Expand All @@ -79,7 +80,7 @@ agent:
#
# Accepts duration, the default is 10s

# connect_timeout: 10s
# connect_timeout: 10s

# ----------------------------------------------------------------------
# | Console UI |
Expand All @@ -92,7 +93,7 @@ agent:
# false - Disable the console UI, use structured log format.
# iftty - (Default) Enable UI only if standard out is a TTY.

# console_ui: iftty
# console_ui: iftty

# ----------------------------------------------------------------------
# | Console UI Color |
Expand All @@ -103,7 +104,7 @@ agent:
# To use a color other than black, set to `transparent` and adjust your
# terminal's background.

# console_ui_color: transparent
# console_ui_color: transparent

# ----------------------------------------------------------------------
# | CRL No Verify |
Expand All @@ -113,7 +114,7 @@ agent:
#
# Accepts a boolean. Default is `false`.

# crl_noverify: false
# crl_noverify: false

# ----------------------------------------------------------------------
# | DNS Resolver IPs |
Expand All @@ -123,9 +124,9 @@ agent:
#
# Defaults to using the local system DNS servers.

# dns_resolver_ips:
# - 1.1.1.1
# - 8.8.8.8
# dns_resolver_ips:
# - 1.1.1.1
# - 8.8.8.8

# ----------------------------------------------------------------------
# | Heartbeat Interval |
Expand All @@ -136,7 +137,7 @@ agent:
#
# Accepts a duration (e.g., 10s, 1m). The default value is `10s`.

# heartbeat_interval: 10s
# heartbeat_interval: 10s

# ----------------------------------------------------------------------
# | Heartbeat Tolerance |
Expand All @@ -147,7 +148,7 @@ agent:
#
# Accepts a duration (e.g., 10s, 1m). The default value is `15s`.

# heartbeat_tolerance: 15s
# heartbeat_tolerance: 15s

# ----------------------------------------------------------------------
# | Inspect DB Size |
Expand All @@ -160,7 +161,7 @@ agent:
#
# (!) To disable inspection for all endpoints, set the value to `-1`.

# inspect_db_size: 52428800 # 50MB
# inspect_db_size: 52428800 # 50MB

# ----------------------------------------------------------------------
# | Log Level |
Expand All @@ -175,7 +176,7 @@ agent:
# info - (Default) Informational messages.
# debug - Detailed debugging info.

# log_level: info
# log_level: info

# ----------------------------------------------------------------------
# | Log Format |
Expand All @@ -188,7 +189,7 @@ agent:
# json - Newline-separated JSON objects.
# term - Colored format for TTY; otherwise, same as logfmt.

# log_format: json
# log_format: json

# ----------------------------------------------------------------------
# | Log |
Expand All @@ -202,7 +203,7 @@ agent:
# false - disable logging
# <path> - write log records to file path on disk

# log: /var/log/ngrok.log
# log: /var/log/ngrok.log

# ----------------------------------------------------------------------
# | Metadata |
Expand All @@ -212,7 +213,7 @@ agent:
#
# Maximum 4096 characters.

# metadata: '{"serial": "00012xa-33rUtz9", "comment": "For customer [email protected]"}'
# metadata: '{"serial": "00012xa-33rUtz9", "comment": "For customer [email protected]"}'

# ----------------------------------------------------------------------
# | Proxy URL |
Expand All @@ -223,7 +224,7 @@ agent:
# (!) ngrok will also respect the `http_proxy`, `http_proxy_env`, and `socks5_proxy`
# environment variables.

# proxy_url: socks5://localhost:9150
# proxy_url: socks5://localhost:9150

# ----------------------------------------------------------------------
# | Remote Management |
Expand All @@ -234,7 +235,7 @@ agent:
#
# Defaults to `true`.

# remote_management: false
# remote_management: false

# ----------------------------------------------------------------------
# | Root CAs |
Expand All @@ -248,20 +249,7 @@ agent:
# host - Use the root certificates trusted by the host's OS (useful for MITM proxies with DPI).
# <path> - Path to a PEM file with additional trusted certificate authorities.

# root_cas: trusted

# ----------------------------------------------------------------------
# | Server Address |
# ----------------------------------------------------------------------

# This is the URL of the ngrok server to connect to.
#
# (!) You should only set this value if you are using a Custom Agent
# Ingress URL.
#
# https://ngrok.com/docs/agent/ingress/#customize-agent-ingress-address

# server_addr: tunnel.us.ingress.example.com:443
# root_cas: trusted

# ----------------------------------------------------------------------
# | Update Channel |
Expand All @@ -276,7 +264,7 @@ agent:
# unstable - Nightly builds; may be unstable. Not for production.
# beta - Beta builds; may be unstable. Not for production.

# update_channel: stable
# update_channel: stable

# ----------------------------------------------------------------------
# | Update Check |
Expand All @@ -286,7 +274,7 @@ agent:
#
# Defaults to true.

# update_check: false
# update_check: false

# ----------------------------------------------------------------------
# | Web Address |
Expand All @@ -297,7 +285,7 @@ agent:
# https://ngrok.com/docs/agent/web-inspection-interface/
# https://ngrok.com/docs/agent/api/

# web_addr: localhost:4040
# web_addr: localhost:4040

# ----------------------------------------------------------------------
# | Web Allow Hosts |
Expand All @@ -317,9 +305,9 @@ agent:
# The default only allows localhost-like Hosts (localhost, 127.0.0.1,
# ::1, etc.).

# web_allow_hosts:
# - 8.8.8.8
# - example.com
# web_allow_hosts:
# - 8.8.8.8
# - example.com

# ######################################################################
# # Endpoints Configuration #
Expand Down