Cloudflared - Universal docker mod

In docker arguments, set an environment variable DOCKER_MODS=linuxserver/mods:universal-cloudflared

If no additional parameters are supplied this mod builds cloudflared from source using the latest release tag and adds it to any LSIO docker image.

If all additional parameters are supplied this docker mod will also create/configure/route/enable a cloudflare tunnel via cloudflared and the cloudflare v4 API.

Usage

Here an example snippet to help you get started using this docker mod.

docker-compose (recommended)

  swag:
    image: ghcr.io/linuxserver/swag
    container_name: swag
    cap_add:
      - NET_ADMIN
    environment:
      PUID: 1000
      PGID: 1000
      TZ: Europe/London
      URL: yourdomain.url
      SUBDOMAINS: test,gitlab,gitlab-ssh,
      VALIDATION: dns
      DNSPLUGIN: cloudflare #optional
      ONLY_SUBDOMAINS: true #optional
      EMAIL: #optional
      EXTRA_DOMAINS: #optional
      STAGING: false #optional
      DOCKER_MODS: linuxserver/mods:universal-cloudflared
      CF_ZONE_ID: #optional
      CF_ACCOUNT_ID: #optional
      CF_API_TOKEN: #optional
      CF_TUNNEL_NAME: example #optional
      CF_TUNNEL_PASSWORD: pleasedontusethisexamplepassword #optional
      CF_TUNNEL_CONFIG: | #optional
        ingress:
          - hostname: test.yourdomain.url
            service: hello_world
          - hostname: gitlab.yourdomain.url
            service: https://localhost:443
          - hostname: gitlab-ssh.yourdomain.url
            service: ssh://localhost:22
          - service: http_status:404
    volumes:
      - /path/to/appdata/config:/config
    ports:
      - 443:443
      # - 80:80 #optional
    restart: unless-stopped

Parameters

Container images/mods are configured using parameters passed at runtime (such as those above).

Parameter	Function	Notes
DOCKER_MODS	Enabled this docker mod with linuxserver/mods:universal-cloudflared	If adding multiple mods, enter them in an array separated by |, such as DOCKER_MODS: linuxserver/mods:universal-cloudflared|linuxserver/mods:universal-mod2

Optional tunnel parameters

Parameter	Function	Notes
CF_ZONE_ID	Cloudflare zone ID
CF_ACCOUNT_ID	Cloudflare account ID
CF_API_TOKEN	Cloudflare API token	Must have the Account.Argo Tunnel:Edit and Zone.DNS:Edit permissions.
CF_TUNNEL_NAME	Cloudflare tunnel name
CF_TUNNEL_PASSWORD	Cloudflare tunnel password	32 char minimum
CF_TUNNEL_CONFIG	Cloudflare tunnel config, please refer to cloudflares official tunnel docs.	Do not add tunnel/credentials-file headers, these are handled automatically.