Before you install Cloudflare Tunnel as a service on your OS, follow Steps 1 through 4 of the
Tunnel CLI setup guide
. At this point you should have a named tunnel and a
config.yml
file in your
$HOME/.cloudflared
directory.
1. Configure
cloudflared
as a service
By default, Cloudflare Tunnel expects all of the configuration to exist in the
$HOME/.cloudflared/config.yml
configuration file
. At a minimum you must specify the following arguments to run as a service:
Argument
Description
tunnel
The UUID of your tunnel
credentials-file
The location of the credentials file for your tunnel
2. Run
cloudflared
as a service
You can install the service to either run at login or at boot.
Run at login
Open a terminal window and run the following command:
Terminal window
cloudflaredserviceinstall
Cloudflare Tunnel will be installed as a launch agent and start whenever you log in, using your local user configuration found in
~/.cloudflared/
.
Run at boot
Open a terminal window and run the following command:
Terminal window
sudocloudflaredserviceinstall
Cloudflare Tunnel will be installed as a launch daemon and start whenever your system boots, using your configuration found in
/etc/cloudflared
.