cloudflare-docs icon indicating copy to clipboard operation
cloudflare-docs copied to clipboard

Very difficult to find full reference for Cloudflare Tunnel YML file format

Open simeyla opened this issue 1 year ago • 1 comments

Which Cloudflare product(s) does this pertain to?

WARP Client

Subject Matter

Full schema for config.yml files

Content Location

It is very difficult to find explanation of certain options like the following for yml files for Cloudflare Tunnel:

no-tls-verify: true
logfile: filename.txt
loglevel: warn

The configuration file documentation makes no mention of any of them. I had to look at the source code to figure out how to change log level.

There is an option noTlsVerify that is documented under Origin Configuration but there is no additional explanation that it needs to be no-tls-verify in the yml file.

I'm sure I'm missing useful options but it's too hard to figure out one by one what they need to be called.

Additional information

PS. I think 'Warp Client' is what is now called 'Cloudflare Tunnel' - so you also need to update the dropdown on this page (where I am creating the issue).

See also community issue I opened

simeyla avatar Feb 22 '24 03:02 simeyla

Thanks for the feedback! I've opened an internal ticket to get this updated.

ranbel avatar Feb 22 '24 17:02 ranbel

Hey @simeyla, Cloudflare is deprioritizing locally-managed tunnels (i.e. YML file configuration) and recommending that customers use remotely-managed tunnels. For a remotely-managed tunnel, noTLSVerify and loglevel are configured in the dashboard. The cloudflared CLI is the source of truth for locally-managed tunnels. We won't be adding a full reference to the dev docs, but I've added a note in #14801 that refers users to the CLI help text.

ranbel avatar May 28 '24 22:05 ranbel

Great, thanks for clarifying.

I only look at my tunnels about twice a year (!) - so good to know the direction, and thanks for adding the note.

simeyla avatar May 28 '24 22:05 simeyla