ngrok

The ngrok agent is a lightweight command-line program that forwards traffic from endpoints on the ngrok cloud service to your upstream services.

Detected by ngrok | macOS, Linux, Windows |ngrok.com

Sync it ngrok.toml

Sync rules

What travels, what stays, what never leaves

ngrok in your home directory Every rule on this page, by file

authtokenapi_keyagent.authtokenagent.api_key

Lifted into your secret store; the rest of the file syncs.

authtokenapi_keyagent.authtokenagent.api_key

Lifted into your secret store; the rest of the file syncs.

authtokenapi_keyagent.authtokenagent.api_key

Lifted into your secret store; the rest of the file syncs.

authtokenapi_keyagent.authtokenagent.api_key

Lifted into your secret store; the rest of the file syncs.

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/ngrok.tomlThe file this page is generated from

id = "ngrok"

name = "ngrok"

homepage = "https://ngrok.com"

description = "The ngrok agent is a lightweight command-line program that forwards traffic from endpoints on the ngrok cloud service to your upstream services."

icon = "SimpleIcons:ngrok"

detect = ["ngrok"]

# https://ngrok.com/docs/agent/config/ gives the default config file as

# ~/.config/ngrok/ngrok.yml on Linux, ~/Library/Application Support/ngrok/ngrok.yml

# on macOS and %LocalAppData%\ngrok\ngrok.yml on Windows. ngrok 2 kept it in

# ~/.ngrok2/ngrok.yml on every platform (%HOMEPATH%\.ngrok2\ngrok.yml on

# Windows, which resolves to the same ~/ path). The v3 agent still reads that

# file where it exists — it warns "ngrok config file found at legacy location,

# move to XDG location" and offers `ngrok config upgrade --relocate`

# (https://ngrok.com/docs/agent/upgrade-v2-v3/) — so it is listed too; a

# consumer skips whichever is absent.

paths = [

"~/Library/Application Support/ngrok/ngrok.yml",

"~/.config/ngrok/ngrok.yml",

"%LOCALAPPDATA%/ngrok/ngrok.yml",

"~/.ngrok2/ngrok.yml",

]

exclude = []

# The file is not a whole-file secret: the endpoint and tunnel definitions,

# the region, the proxy settings and the web-UI address are the parts worth

# carrying between machines. Only the two credentials are lifted out.

secret = []

side_effect = false

# Every spelling, or the credentials are lifted out on one platform and sync

# in the clear from the others.

# Both shapes the agent has written: version 2 files put authtoken and api_key

# at the top level (https://ngrok.com/docs/agent/config/v2/), and the version 3

# format moved them under `agent`

# (https://ngrok.com/docs/agent/config/v3/: "agent:\n authtoken: ...",

# "agent:\n api_key: ..."). A rule naming only the current one would resolve

# to nothing on a file still in the old shape — and for a credential that means

# syncing it in the clear.

[[secret_paths]]

file = [

"~/Library/Application Support/ngrok/ngrok.yml",

"~/.config/ngrok/ngrok.yml",

"%LOCALAPPDATA%/ngrok/ngrok.yml",

"~/.ngrok2/ngrok.yml",

]

match = { key_path = ["authtoken", "api_key", "agent.authtoken", "agent.api_key"] }

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/ngrok. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page.