Scripts

Script Updates

Currently there is no auto-update for the configure-rf or helper scripts so you may want to check for updates periodically.

The configure-rf script will print the existing versions on your system when it runs:

📜 Existing script versions:
🔸 configure-rf.sh           2025.6.2.1
🔸 health_check.sh           2025.5.26.1
🔸 minio_init.sh             2025.5.31.1
🔸 update_containers.sh      2025.5.31.1
🔸 update_rf_containers.sh   2025.5.27.1

You can check the release notes to see if there any updates or view the .sh files directly on GitHub looking for any # VERSION comments towards the top of each script.

Remove the scripts:

rm configure-rf.sh health_check.sh minio_init.sh update_containers.sh update_rf_containers.sh shared_functions.sh

The command below will re-download the configure-rf script and run it which will then re-download the helper scripts:
```
curl -O https://raw.githubusercontent.com/Ne0n09/cloudflared-remotefalcon/main/configure-rf.sh; \
chmod +x configure-rf.sh; \
./configure-rf.sh
```
Note

To check for updates to compose.yaml, .env, and default.conf check the instructions here

Scripts Details

Click through the tabs below to view detailed information for each script.

Configure RFUpdate RF ContainersUpdate ContainersHealth CheckGenerate JWTMake AdminRevertMinIO InitShared Functions

This script is used for the initial setup and configuration of cloudflared-remotefalcon.
It guides you on setting the required and some optional .env variables.
It can be re-run to view or update the variables or to run the container update or health check scripts.
Automatically downloads other helper scripts if they are missing.
Automatically creates the remotefalcon and remotefalcon-backups directories.
Automatically downloads the compose.yaml, .env, and default.conf files if they are missing.

Run configure-rf.sh

./configure-rf.sh

This script will update the Remote Falcon containers to the latest available commit on the Remote Falcon Github.
The compose.yaml build context hash is updated to the latest commit for the container.

The image tag for the container is updated in the compose.yaml to the short-hash:

  plugins-api:
    build:
      context: https://github.com/Remote-Falcon/remote-falcon-plugins-api.git#cc1593aab27dc195a4c55b5b1410ddc06e96a60c
      args:
        - OTEL_OPTS=${OTEL_OPTS}
    image: plugins-api:cc1593a
    container_name: plugins-api

A backup of the compose.yaml is created when any of the containers are updated.
The script accepts two arguments:
1. [dry-run|auto-apply|interactive]
  - dry-run: Displays if any updates are available or if up to date.
  - auto-apply: Automatically update all RF containers if any updates are found.
  - interactive/no argument: Display if update is available and prompt for confirmation before updating each container.
2. [health]
  - Add health after the first argument to automatically run the health_check script.

update_rf_containers script syntax examples

./update_rf_containers.sh [dry-run|auto-apply|interactive] [health]
./update_rf_containers.sh
./update_rf_containers.sh dry-run health
./update_rf_containers.sh auto-apply

This script will check and update the non-Remote Falcon containers to their latest available release.
The compose.yaml container image tag is updated to the latest release.
A backup of the compose.yaml is created when any of the containers are updated.
The script accepts three arguments:
1. [all|mongo|minio|nginx|cloudflared]
  - container_name: You can specify an individual container or all. If left blank with no other arguments it will check all containers in interactive mode.
2. [dry-run|auto-apply|interactive]:
  - dry-run: Displays if any updates are available or if up to date.
  - auto-apply: Automatically update all RF containers if any updates are found.
  - interactive/no argument: Display if update is available and prompt for confirmation before updating each container.
3. [health]
  - Add health after the first two arguments to automatically run the health_check script.

update_containers script syntax examples

./update_containers.sh [all|mongo|minio|nginx|cloudflared] [dry-run|auto-apply|interactive] [health]
./update_containers.sh
./update_containers.sh all dry-run health
./update_containers.sh all auto-apply

This script will perform a 'health check' of various things and displays any issues that are found.
Checks if containers are running.
Checks Remote Falcon endpoints.
Checks if the domain is not the default.
Checks if the .env file exists.
Checks if the Cloudflare Origin certificate and key exist and if they match.
Checks NGINX configuration and tests it.
Checks various MinIO configuration details for Image Hosting.
Checks Mongo to search for any shows that are configured and provides their URL.

Run health_check.sh

./health_check.sh

This is to be able to make use of the External API.
Assists with getting your API access token and secret key from your Remote Falcon show in the MongoDB database without having Sendgrid configured for email.
Then the script generates a JWT for you to use.

Download generate_jwt.sh

  curl -O https://raw.githubusercontent.com/Ne0n09/cloudflared-remotefalcon/refs/heads/main/generate_jwt.sh; \
  chmod +x generate_jwt.sh

Run generate_jwt.sh

./generate_jwt.sh

This script will display shows that have admin access and allow you to toggle admin access when the show subdomain is passed as an argument.
Run the script with no arguments to display currently configured showRole(USER/ADMIN).
This basically lets you see and edit MongoDB information from within Remote Falcon.

Download make_admin.sh

  curl -O https://raw.githubusercontent.com/Ne0n09/cloudflared-remotefalcon/refs/heads/main/make_admin.sh; \
  chmod +x make_admin.sh

Run make_admin.sh

./make_admin.sh

This script will allow you to revert to a previous backup of the .env, compose.yaml, or MongoDB.
The script looks for backups in the 'remotefalcon-backups' directory.

Download revert.sh

  curl -O https://raw.githubusercontent.com/Ne0n09/cloudflared-remotefalcon/refs/heads/main/revert.sh; \
  chmod +x revert.sh

Run revert.sh

./revert.sh

This script will configure MinIO. Minio is a lightweight object storage server.
The script is called when 'configure-rf.sh' is run and if certain default values are found in the .env file for a hands-off setup and configuration.
The minio container is configured for local direct access to the control-panel container.
This lets you use the Image Hosting tab in the Control Panel which allows you to self host your viewer page images.
The script can be run again manually with no ill-effects to ensure MinIO is configured properly.
The script is automatically downloaded by configure-rf.

This is a helper script for functions and variables that are re-used across the other scripts.