BeamUp Panel

The idea of this Panel is to be deployed with the stremio-beamup project.

The BeamUp Web Panel includes the following features:

• log in with github
• see deployed projects and their status
• download logs for a deployed project
• restart a deployed project
• delete a deployed project

Building

npm install
npm run build

Production Deployment

For a detailed production setup guide, see PRODUCTION_SETUP.md.

Quick Setup Summary:

1. Set up environment variables in .env
2. Set up system services (systemd) and Nginx reverse proxy
3. Configure firewall and sudo permissions
4. Deploy the application (as dokku user):

   sudo -u dokku bash -c 'cd /opt/beamup-panel && ./scripts/production-deploy.sh'

Local Testing

The app ports need to be set manually, create a .env file in the root folder of the project, and add:

REACT_APP_SERVER_PORT=5050
REACT_APP_PORT=3999
SERVER_PORT=$REACT_APP_SERVER_PORT
PORT=$REACT_APP_PORT
WDS_SOCKET_PORT=$REACT_APP_PORT

In this example's case, the app should be accessed from http://localhost:5050.

Three more env vars will need to be added to the .env file for the app to work, these are explained below.

Create an OAuth app under your github username (these are required for CLIENT_ID and CLIENT_SECRET env vars), see this article for details: https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/

(Note: while creating the OAuth app, you can set your Homepage URL to http://localhost:5050/ and Authorization Callback URL to http://localhost:5050/login)

After setting all required ENV vars, start the app with npm start

Optional Env Vars

SESSIONS_FOLDER=../ # a folder that is persisted for sessions data
SESSIONS_EXPIRE=2592000000 # 30 days

Adding a Custom News Page

To include a custom news.html page for deployment:

1. Create news.html: Develop your custom HTML file.

2. Place in public directory: Add the news.html file to the public directory of the project.

3. Verify: Ensure the server is running and access the page at https://your-deployment-url/news.html.