Skip to content

SETUP.md

Latest commit

 

History

History
83 lines (55 loc) · 2.3 KB

SETUP.md

File metadata and controls

83 lines (55 loc) · 2.3 KB

Setup

A short tutorial on how to setup f1-dash via docker compose or kubernetes.

Components

dashboard

Techstack: Next.js, TypeSecript

The website/dashboard itself. Gets data from api and realtime service.

envs:

NEXT_PUBLIC_LIVE_URL=http://localhost:4000
API_URL=http://localhost:4001

# rybbit tracking script and id
TRACKING_ID=
TRACKING_URL=

build envs:

SKIP_ENV_VALIDATION=1		# skips env validation, use for docker
NEXT_STANDALONE=1 			# enables nextjs standalone build, use for docker
NEXT_NO_COMPRESS=1 			# disables nextjs compression, use when using proxy compression

note: you can't change build variables when using the public f1-dash image. But you can set them when building your own.

realtime

Techstack: Rust, SignalR, Axum

Connects to f1 over signalr and serves realtime data over websockets to dashboard.

envs:

# logging
RUST_LOG=realtime=info

# Address where the webserver opens on with port
ADDRESS=0.0.0.0:4000

# CORS Origin, set to dashboard address
ORIGIN="https://f1-dash.com"

# (optional) endpoint for simulator
F1_DEV_URL=ws://localhost:8000/ws

api

Techstack: Rust, Axum

Handles all non realtime data depended things like past & future sessions.

envs:

# logging
RUST_LOG=api=info

# Address where the webserver opens on with port
ADDRESS=0.0.0.0:4001

# CORS Origin, set to dashboard address
ORIGIN="https://f1-dash.com"

Platforms

Please not when choosing the dockerimages / choosing which tag, if you use latest or develop, which are moving tags and are not fixed, things might break over time.

Docker Compose

There is a basic docker compose file in the root of the project. This is a very basic setup only expected to run on a local machine and only expected to be accessed from there. If you want to host f1-dash on a server or also access it from other devices on your local network then adjustments have to be made like setting the ORIGIN environment variable or setting up a reverse proxy.

Kubernetes

There is a kubernetes setup in the .k8s folder. This is a more advanced setup expected to run on a server and be accessed from other devices on your local network or even the internet. This is the way f1-dash.com is hosted. There's no Helm Chart for now just a few yamls. Ingress/Gatway is not included as this is very specific to your setup.