baudflow

Getting Started

Prerequisites

  • Elixir 1.19+ and Erlang/OTP 29+
  • PostgreSQL
  • The Ookla Speedtest CLI, installed and on your $PATH

Quick start

# Install deps, create the database, and run migrations
mix setup

# Start the Phoenix server
mix phx.server

Now visit localhost:4000. You can also run inside an IEx session:

iex -S mix phx.server

The dashboard is live. Trigger a manual speed test from the home page, or wait for the scheduler to fire one — the CRT oscilloscope streams the run in real time.

Run with Docker

Prefer a container? An image is published for each release:

docker run -d \
  -p 4000:4000 \
  -e DATABASE_URL=ecto://user:pass@db-host/baudflow \
  -e SECRET_KEY_BASE=replace-with-a-long-random-value \
  ghcr.io/v1nvn/baudflow:0.6.0

A docker-compose.yml is included in the repo for a single-command stack with Postgres. See the Deployment guide for the full setup.

Next steps