Extra
Update or view the .env file manually outside of the configure-rf script
The configure-rf script isn't required to view or make updates to the .env file.
You can manually edit the file, but the compose stack will have to be brought down manually and the Remote Falcon images rebuilt for some settings to take effect.
-
To view the .env file:
-
To manually edit the .env file:
External API
Follow the steps below to get access to the external API for your self hosted Remote Falcon.
-
From the Control Panel Dashboard click the gear icon on the top right
-
Click Account
-
Click Request Access to the right of Request API Access
Note
Ignore the Unexpected Error or API Access Already Requested if you do not have email configured. The API token and secret will still be generated.
-
Copy the command below and paste it to download and run the generate_jwt script:
curl -O https://raw.githubusercontent.com/Ne0n09/cloudflared-remotefalcon/main/generate_jwt.sh; \ chmod +x generate_jwt.sh; \ ./generate_jwt.sh
-
The script will look for a 'mongo' container and list shows that have requested API access in the database.
-
The script will display your JWT that you can use as needed.
-
Testing External API access
You can test your JWT with curl in Linux directly from your RF server.
-
Enter your JWT on the shell to set the JWT variable with:
-
Verify your JWT is set by entering
$JWT
on the shell -
Replace yourdomain.com with your RF domain and run the curl command:
If all went to plan you will see output similar to the below if you have a freshly configured account.
{"preferences":{"viewerControlEnabled":false,"viewerControlMode":"JUKEBOX","resetVotes":false,"jukeboxDepth":0,"locationCheckMethod":null,"showLatitude":0.0,"showLongitude":0.0,"allowedRadius":1.0,"jukeboxRequestLimit":0,"locationCode":null,"hideSequenceCount":0,"makeItSnow":false},"sequences":[],"sequenceGroups":[],"requests":[],"votes":[],"playingNow":null,"playingNext":null,"playingNextFromSchedule":null}
References:
Admin access
-
This will provde a new Admin section on the left-hand menu on the Control Panel.
-
It will let you search for show subdomains and let you basically view/edit the MongoDB record.
-
The make_admin script will display any shows found and whether they are configured as a USER or ADMIN.
-
Copy the command below and paste it to download and run the make_admin script:
-
The script will run and display a list of shows and their roles.
-
Select the number of the show to toggle the role.
-
You can re-run the script to toggle the show from USER or ADMIN:
-
You may have to log out of Remote Falcon and back in again if you receive Unexpected Error when trying to serach for show subdomains.