cloudflared - SynoCommunity/spksrc GitHub Wiki

cloudflared

Cloudflare Tunnel provides you with a secure way to connect your resources to Cloudflare without a publicly routable IP address. With Tunnel, you do not send traffic to an external IP — instead, a lightweight daemon in your infrastructure (cloudflared) creates outbound-only connections to Cloudflare’s edge. Cloudflare Tunnel can connect HTTP web servers, SSH serversremote desktops, and other protocols safely to Cloudflare. This way, your origins can serve traffic through Cloudflare without being vulnerable to attacks that bypass Cloudflare.

Installation

This assumes that you have SynoCommunity repo set up and working

  1. Follow the official Cloudflare Tunnel Setup Guide steps 1.1-1.5
  2. Copy the provided command, e.g. cloudflared.exe service install QuzuvI6bNDaEhf1jBKvIT1NhwA26eH1tlABbCzg9OjcGav5xB3YY0vMTEG25yjf2HpAjL1XVsgCFdr9ROP0RqFpYmDRBhtP0wTj4YY0vMTEG25yjf2HpAjL1XVsgCFdr9ROP0RqFpYmDRBhtP0wTj4vY815Hlg6rkej0nJb07Id1R781y0y6DTJ1
  3. From the command take only the token part, for the example above this would be QuzuvI6bNDaEhf1jBKvIT1NhwA26eH1tlABbCzg9OjcGav5xB3YY0vMTEG25yjf2HpAjL1XVsgCFdr9ROP0RqFpYmDRBhtP0wTj4YY0vMTEG25yjf2HpAjL1XVsgCFdr9ROP0RqFpYmDRBhtP0wTj4vY815Hlg6rkej0nJb07Id1R781y0y6DTJ1
  4. Install the cloudflared package from Package Center
  5. During the installation input only the token part when asked

image1

  1. If you want you can change some advanced options, but the defaults should be good for the majority of users

image

  1. Continue Cloudflare Tunnel Setup Guide from step 1.7

Help

Service is not starting

  • Check your Cloudflare token, it should be a long string of alphanumerical characters with no newlines or spaces
    • As a way to test you can try connecting with the token from another platform (your computer/another server)
  • Try reinstalling the package making sure to check Erase all of the package data files.
  • If you're 100% sure that the token is correct you can read the cloudflared log in /volume1/@appdata/cloudflared/cloudflared.log where volume1 is your system volume. Keep in mind that the log contains your token, so redact all personal information if you intend to share it.

Service is stopping/dying

There have been several reports of service working correctly for some time and then stopping for no apparent reason. The most likely theory is that it's being killed by (what I assume is) some OOM killer. What you can do if you encounter this is either monitor your ram and disable unneeded services or add a Task Scheduler task to start the service every hour.

task scheduler task type

task scheduler task schedule tab task scheduler task settings tab

Client is showing up as outdated in the dashboard/When is update

TL;DR: It doesn't matter, everything will keep working as intended, most likely the newer version isn't faster/safer/etc. than the one you currently have. Cloudflare supports the previous year of cloudflared releases.

Updating the package takes time and everyone here is a volunteer, so don't expect every little patch to be packaged. Update frequency will highly depend on actual changes in cloudflared, the list of which you can find here. As you can see, a lot of changes are related only to the development and the official packaging processes and will not affect you in any meaningful way. If you feel like the package needs to updated, please specify what changes do you find important to warrant a package update. If you'd like you can explain how it affects your workflow, but simply mentioning the change will likely be enough most of the time.