CloudflareTunnelsPlugin

Cloudflare Tunnels Plugin

Automatically download and run remotely-managed cloudflared in the background.

Installation Instructions

1. Install the plugin onto a paper server. Start the server to generate the config file, and stop it.
2. Change all the values in the plugins/cloudflare-tunnels-plugin/config.yml to desired values. (see configuration section below)
3. Restart your server. Note that reloading is not tested and may cause issues.
4. Enjoy! :3

Configuration

• download.url: link to a binary. use the VERSION placeholder to use the version in the download.variable property. Always change if you are not using Linux amd64. See https://github.com/cloudflare/cloudflared/releases for some valid file names.
• download.version: version of cloudflared to download. defaults to the latest version.
• token: your cloudflared token. see https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/
• notify-ops-on-exit: notify server operators when cloudflared exists for any reason, and if it is being restarted.
• log-level: cloudflared log level. defaults to info.
• disable-tls: do not check for valid SSL certificates when using cloudflared.
• restart.auto-restart: automatically restart cloudflared if it exits.
• restart.interval-seconds: time, in seconds, to wait between automatic restarts.
• installed: set to true when the plugin is fully configured (the properties above are all set).

Project Info

The source code is available on Codeberg, and you may make bug reports, feature requests, and pull requests there. The source code is licenced under the Apache 2.0 license.