Skip to content

Repository files navigation

Cloudflared

Build Status Last Commit OCI Pulls

Tunneling daemon that proxies any local webserver through the Cloudflare network without DNS records or firewall changes.

Port 2000
Registry ghcr.io/daemonless/cloudflared
Source https://github.com/cloudflare/cloudflared
Website https://developers.cloudflare.com/cloudflare-one/connections/connect-apps

Version Tags

Tag Description Best For
latest / pkg FreeBSD Quarterly. Uses stable, tested packages. Most users — recommended.
pkg-latest FreeBSD Latest. Rolling package updates. Staying current.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  cloudflared:
    image: "ghcr.io/daemonless/cloudflared:latest"
    container_name: cloudflared
    environment:
      - TUNNEL_TOKEN=YOUR_CLOUDFLARE_TOKEN_HERE  # Required: The Cloudflare Tunnel token.
      - TUNNEL_METRICS=0.0.0.0:2000  # Address to bind metrics server (default: 0.0.0.0:2000)
    ports:
      - "2000:2000"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=cloudflared
TUNNEL_TOKEN=YOUR_CLOUDFLARE_TOKEN_HERE
TUNNEL_METRICS=0.0.0.0:2000

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  cloudflared:
    name: cloudflared
    options:
      - container: 'args:--pull'
      - expose: '2000:2000 proto:tcp'
    oci:
      user: root
      environment:
        - TUNNEL_TOKEN: !ENV '${TUNNEL_TOKEN}'
        - TUNNEL_METRICS: !ENV '${TUNNEL_METRICS}'

Makejail:

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/cloudflared:${tag}

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Podman CLI

podman run -d --name cloudflared \
  -p 2000:2000 \
  -e TUNNEL_TOKEN=YOUR_CLOUDFLARE_TOKEN_HERE \
  -e TUNNEL_METRICS=0.0.0.0:2000 \
  ghcr.io/daemonless/cloudflared:latest

Save as run.sh, then run sh run.sh.

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="2000:2000 proto:tcp" \
  -e TUNNEL_TOKEN=YOUR_CLOUDFLARE_TOKEN_HERE \
  -e TUNNEL_METRICS=0.0.0.0:2000 \
  ghcr.io/daemonless/cloudflared:latest cloudflared

Save the files above, then run sh run.sh.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  cloudflared:
    name: cloudflared
    image: "ghcr.io/daemonless/cloudflared:latest"
    network:
      - mode: host
    environment:
      - TUNNEL_TOKEN=YOUR_CLOUDFLARE_TOKEN_HERE
      - TUNNEL_METRICS=0.0.0.0:2000

Save as bastille-compose.yml, then run bastille up. Or via CLI:

bastille create -O \
  --env TUNNEL_TOKEN=YOUR_CLOUDFLARE_TOKEN_HERE \
  --env TUNNEL_METRICS=0.0.0.0:2000 \
  cloudflared ghcr.io/daemonless/cloudflared:latest inherit

Ansible

- name: Deploy cloudflared
  containers.podman.podman_container:
    name: cloudflared
    image: "ghcr.io/daemonless/cloudflared:latest"
    state: started
    restart_policy: always
    env:
      TUNNEL_TOKEN: "YOUR_CLOUDFLARE_TOKEN_HERE"
      TUNNEL_METRICS: "0.0.0.0:2000"
    ports:
      - "2000:2000"

Save as cloudflared-deploy.yaml, then run ansible-playbook cloudflared-deploy.yaml.

Parameters

Environment Variables

Variable Default Description
TUNNEL_TOKEN YOUR_CLOUDFLARE_TOKEN_HERE Required: The Cloudflare Tunnel token.
TUNNEL_METRICS 0.0.0.0:2000 Address to bind metrics server (default: 0.0.0.0:2000)

Ports

Port Protocol Description
2000 TCP

Architectures: amd64 User: root (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.

About

Tunneling daemon that proxies any local webserver through the Cloudflare network without DNS records or firewall changes.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages