Skip to content

users.md

Latest commit

 

History

History
164 lines (107 loc) · 3.31 KB

users.md

File metadata and controls

164 lines (107 loc) · 3.31 KB

User Guide

Getting started

  1. Open RedTrack.
  2. Add your backend URL, username, and password.
  3. Select your server entry from the list.

Hosted web app: https://redstonecloud.github.io/RedTrack

If you use the hosted web app, your backend URL must use HTTPS (not HTTP). Browsers block mixed-content requests from an HTTPS page to an HTTP API.

Main page

  • Add new server: create a new saved backend profile.
  • Support: use the Discord icon button to open the community support server.

Dashboard

  • View live player metrics and history.
  • Use range controls (Previous 3h, Next 3h, Now) to navigate data windows.

Connection loss handling

If RedTrack cannot reach the backend, a Connection lost screen appears instead of leaving a broken view.

  • The app keeps retrying automatically in the background.
  • You can also press Retry now.
  • Once the backend is reachable again, the dashboard view returns automatically.

Backend setup tutorial (Linux)

This guide uses Ubuntu/Debian-style commands.

1) Install prerequisites

sudo apt update
sudo apt install -y nodejs npm mongodb

If your distro uses mongod from a separate package/repo, install MongoDB using your distro’s official docs.

2) Start and enable MongoDB

sudo systemctl enable --now mongod
sudo systemctl status mongod

3) Get the backend code and install dependencies

cd /path/to/RedTrack/backend
npm ci

4) Create a .env file

In backend/.env:

mongodb_uri=mongodb://127.0.0.1:27017
ping_rate=10000
backend_port=3001
backend_https_enabled=false
backend_https_key_path=/path/to/privkey.pem
backend_https_cert_path=/path/to/fullchain.pem

Optional HTTPS settings:

  • backend_https_enabled=true switches the backend to HTTPS mode.
  • backend_https_key_path and backend_https_cert_path must point to readable PEM files that always exist when HTTPS is enabled.

5) Start the backend

Development mode:

npm run dev

Production-style run:

npm run build
npm start

6) First login

On first boot, RedTrack creates a default admin user:

  • Username: admin
  • Password: changeme

Log in and change the password immediately.

Backend setup tutorial (Windows)

1) Install prerequisites

  • Install Node.js LTS from nodejs.org
  • Install MongoDB Community Server from mongodb.com

2) Start MongoDB service

After install, ensure the MongoDB Windows service is running.

In PowerShell (as Administrator):

Get-Service MongoDB
Start-Service MongoDB

3) Install backend dependencies

cd C:\path\to\RedTrack\backend
npm ci

4) Create .env

Create backend\.env with:

mongodb_uri=mongodb://127.0.0.1:27017
ping_rate=10000
backend_port=3001
backend_https_enabled=false
backend_https_key_path=/path/to/privkey.pem
backend_https_cert_path=/path/to/fullchain.pem

5) Start backend

Development mode:

npm run dev

Production-style run:

npm run build
npm start

6) Connect from RedTrack app

Use backend URL:

  • https://localhost:3001 (same machine, with trusted/local cert setup)
  • https://<your-server-ip>:3001 (LAN/remote client, with valid cert)

Then log in with default credentials (admin / changeme) and change the password.