Files

Below you will find a summary of each file that is in the remotefalcon directory.

The configure-rf script will download these automatically if they do not exist.

compose.yaml

The compose.yaml defines all the containers and makes heavy use of the .env file.

There is typically no need to manually edit this file.

Most of the ports in the compose are not 'published' to help isolate the containers from the local network.

The exceptions are plugins-api(8083:8083) and MinIO(9000:9000,9001:9001) which allows for direct LAN access to these containers.

plugins-apiminio

compose.yaml
plugins-api:
    build:
    context: https://github.com/Remote-Falcon/remote-falcon-plugins-api.git
    args:
        - OTEL_OPTS=${OTEL_OPTS}
    image: plugins-api:latest
    container_name: plugins-api
    restart: always
    ports:
    - "8083:8083"

compose.yaml
minio:
    image: minio/minio:latest
    container_name: remote-falcon-images.minio
    restart: always
    ports:
    - '9000:9000'
    - '9001:9001'

.env

The .env file specifies all the variables that are used in the compose.yaml.

Some of these are updated by the configure-rf script.

The .env file can be edited manually with nano remotefalcon/.env.

.env variables

TUNNEL_TOKEN: The configure-rf script guides on setting this. Change to the Cloudfare tunnel token from the overview page of the tunnel.
DOMAIN: The configure-rf script guides on setting this. Change "your_domain.com" to your real domain.
VIEWER_JWT_KEY: The configure-rf script will generate a random value for both of these when it is run.
USER_JWT_KEY: The configure-rf script will generate a random value for both of these when it is run.
HOSTNAME_PARTS: Change this to the number of parts in your hostname. For example, domain.com would be two parts ('domain' and 'com'), and sub.domain.com would be 3 parts ('sub', 'domain', and 'com'). For cloudflare 3 parts will not work unless you purchase Advanced Certificate Manager.
AUTO_VALIDATE_EMAIL: The configure-rf script guides on setting this. Without a SendGrid key emails will not be sent so this option allows you to auto validate sign ups without sending an email.
NGINX_CONF: Specifies the path to the NGINX default.conf file. There is no need to modify this.
NGINX_CERT: The configure-rf script guides on setting this. Specifies the path to the SSL certifcate used by NGINX.
NGINX_KEY: The configure-rf script guides on setting this. Specifies the path to the SSL private key used by NGINX.
HOST_ENV: There is no need to change this from 'prod'.
VERSION: The update_rf_containers script updates this when it is run and one of the RF containers gets updated. This changes the version displayed in the lower left of the Control Panel in the YYYY.MM.DD format.
GOOGLE_MAPS_KEY: This is used for the Remote Falcon Shows Maps on the Control Panel.
PUBLIC_POSTHOG_KEY: This is used for analytics. You can create a free account at Create this at PostHog
PUBLIC_POSTHOG_HOST: This specifies the PostHog host to use from your Posthog settings page.
GA_TRACKING_ID: Google Analytics Measurement ID/gtag.
MIXPANEL_KEY: Mixpanel analytics key.
CLIENT_HEADER: CF-Connecting-IP is used for Cloudflare to get the actual client IP address for viewer statistics. For Non-Cloudflare you may need to change to X-Forwarded-For or X-Real-IP
SENDGRID_KEY: For sending validation email if you have a SendGrid account.
GITHUB_PAT: GitHub Personal Access Token. This is not required.
SOCIAL_META: The configure-rf script gives the option of setting this. Check the Remote Falcon Developer Docs for more details.
SEQUENCE_LIMIT: This is the sequence limit for the number of sequences that a show can sync with Remote Falcon. The default is 200.
MONGO_PATH: This specifies the path where the MongoDB container data is stored on your server. The default is: /home/mongo-volume. The configure-rf script does NOT modify this.
MONGO_INITDB_ROOT_USERNAME: Specifies the root username for MongoDB. The configure-rf script currently does NOT modify this.
MONGO_INITDB_ROOT_PASSWORD: Specifies the root password for MongoDB. The configure-rf script currently does NOT modify this.
MONGO_URI: Combines the MongoDB root username and password together into the URI path. There is no need to modify this.
MINIO_PATH: This specifies the path where the MinIO container data is stored on your server. The default is: /home/minio-volume. The configure-rf script does NOT modify this.
MINIO_ROOT_USER: Specifies the root user for MinIO. The minio-init script will automatically update the default value to a random value.
MINIO_ROOT_PASSWORD: Specifies the root password for MinIO. The minio-init script will automatically update the default value to a random value.
S3_ENDPOINT: Specifies the S3 endpoint URL for the control-panel container to use for Image Hosting.
S3_ACCESS_KEY: Specifies the S3 access key for MinIO 'remote-falcon-images' bucket. The minio-init script will automatically update the default value to a random value.
S3_SECRET_KEY: Specifies the S3 seceret key for MinIO 'remote-falcon-images' bucket. The minio-init script will automatically update the default value to a random value.
OTEL_URI: This is used for OpenTelemry.
OTEL_OPTS: This is used for OpenTelemry.
SWAP_CP: Set to true or false. When true, it allows for swapping the Viewer Page Subdomain that is set with VIEWER_PAGE_SUBDOMAIN with the Control Panel so that the Viewer Page is accessible at https://your_domain.com and the Control Panel is accessible at https:\\controlpanel.your_domain.com.
VIEWER_PAGE_SUBDOMAIN: Set to a valid show name. Must be all lower case with no spaces.

default.conf

The default.conf is used for NGINX and defines its configuration.