Skip to content

Repository files navigation

Cloudflared

Build Status Last Commit

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  # Optional: Address to bind metrics server (default: 0.0.0.0:2000)
    ports:
      - "2000:2000"
    restart: unless-stopped

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: 'boot 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 overwrite=force
OPTION from=ghcr.io/daemonless/cloudflared:${tag}

Note: 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 IPv4 address assigned by the virtual network.

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

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

Note: 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 IPv4 address assigned by the virtual network.

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"

Parameters

Environment Variables

Variable Default Description
TUNNEL_TOKEN YOUR_CLOUDFLARE_TOKEN_HERE Required: The Cloudflare Tunnel token.
TUNNEL_METRICS 0.0.0.0:2000 Optional: 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