About

cloudflared-remotefalcon helps you self host Remote Falcon through guided setup and configuration using Cloudflare Tunnels and your own server capable of running Docker through the use of various helper scripts.

Ready to get started?

Check out the Remote Falcon Docs to learn more about Remote Falcon.

Architecture

Adding a bit to the Remote Falcon architecture diagram from here, we have Cloudflared and Versity Gateway.

All web traffic goes through Cloudflared directly into NGINX.

Then we also have Versity Gateway to provide object storage. The control-panel connects directly to Versity Gateway and Versity Gateway is connected to NGINX to allow for images to be viewable when used on the viewer page.

cloudflared-remotefalcon flowchart

---
config:
  layout: fixed
---
flowchart LR
  %% RF containers
  control_panel([remote-falcon-control-panel])
  viewer([remote-falcon-viewer])
  plugins_api([remote-falcon-plugins-api])
  external_api([remote-falcon-external-api])
  ui([remote-falcon-ui])

  %% Non-RF containers
  nginx([nginx])
  cloudflared([cloudflared])
  mongo([MongoDB])
  versitygw([Versity Gateway])
  fpp(["FPP/xSchedule"]) 

  %% Connections based on depends_on and service usage
  control_panel --> mongo
  control_panel --> versitygw
  viewer --> mongo
  plugins_api --> mongo
  external_api --> mongo
  external_api --> viewer
  ui --> control_panel
  ui --> viewer
  nginx --> control_panel
  nginx --> viewer
  nginx --> plugins_api
  nginx --> external_api
  nginx --> ui
  nginx --> versitygw
  cloudflared --> nginx
  fpp --> plugins_api

  click control_panel href "about/containers#control-panel" "Control Panel Container"
  click viewer href "about/containers#viewer" "Viewer Container"
  click plugins_api href "about/containers#plugins-api" "Plugins API Container"
  click external_api href "about/containers#external-api" "External API Container"
  click ui href "about/containers#ui" "UI Container"
  click nginx href "about/containers#nginx" "NGINX Container"
  click cloudflared href "about/containers#cloudflared" "Cloudflared Container"
  click versitygw href "about/containers#versitygw" "Versity Gateway Container"
  click mongo href "about/containers#mongo" "MongoDB Container"