Skip to content

atnplex/cloudflared-unraid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 

Repository files navigation

Unraid Cloudflared Plugin (Zero Docker)

License: Unlicense GitHub release Unraid Version Cloudflared

A robust, highly reliable plugin to run Cloudflare Tunnel (cloudflared) natively on Unraid without Docker. Starts instantly on boot, protecting your remote access even if the array or cache pool is offline.

This plugin ensures zero flash wear by routing logs to RAM, provides a clean native WebGUI, handles auto-restarts via a resilient watchdog, and decouples credential storage from process arguments.

🚀 Key Features

  • Bare-Metal Reliability: Runs directly alongside emhttpd. Accessible even during array failures or maintenance.
  • Zero Flash Wear: Explicitly disables cloudflared auto-updates, sets HOME=/tmp, and forces logs into bounded RAM (/var/log/cloudflared). Your USB drive suffers no telemetry or cache writes.
  • Secure Tunnel Token: Your JWT token is kept in a restricted 0600 file (/boot/config/plugins/cloudflared/config/token or token.json) on the flash drive and passed securely to the binary via --token-file. It is never visible in ps or htop commands (unlike many Docker templates and plugin forks).
  • Native WebGUI: Integrated natively into Unraid's Settings tab. Monitor live service health, change settings, stream RAM logs, and configure your token.
  • Robust Watchdog: Automatically monitors and restarts the tunnel if the binary crashes.

📥 Installation

Install directly through the Unraid WebGUI using the official .plg manifest.

  1. Navigate to PluginsInstall Plugin
  2. Paste the following URL exactly as shown:
https://github.com/atnplex/cloudflared-unraid/releases/latest/download/cloudflared-unraid.plg
  1. Click Install.

To update to a newer version in the future, simply re-paste the URL and click Install again. All settings, logs, and tokens are safely preserved across upgrades.

(Note: Advanced fallback terminal install methods have been deprecated in favor of this native Unraid GUI approach. Do not use installplg directly with zip files.)

⚙️ Configuration & Security

  1. Navigate to Settings -> Cloudflared in the Unraid WebGUI.
  2. Expand the ⚙️ Configuration Settings accordion.
  3. Paste your Cloudflare Tunnel Token and confirm Enable auto-start on boot is checked, then click Apply Settings.
  4. Click ▶ Start in the Service Control section.

Where does data live?

  • Logs are kept strictly in a 10MB bounds-checked tmpfs partition at /var/log/cloudflared/cloudflared.log.
  • Configuration & Token exist on the Unraid OS Flash Drive at /boot/config/plugins/cloudflared/config/. The token is stored unencrypted (plain text) exactly as generated by Cloudflare, but is guarded tightly by Linux file permissions (0600) to prevent unauthorized local user reading.

🛡️ Upstream & Credit

Forked and reimagined to address flash degradation and reliability problems present in earlier iterations. Reference upstream:

About

Native Unraid plugin for Cloudflare Tunnel (cloudflared).

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Contributors