Install

Pick whichever way suits you. Both give you the same single program, quikcast. The operator console and the country database are built in, so there is nothing else to install.

Download a release (recommended)

1. Open the releases page and download the archive for your system. Builds exist for Linux, macOS and Windows.
2. Extract it. You get the quikcast program (quikcast.exe on Windows) and an example configuration in config/.
3. Check that it runs:

./quikcast --help

Linux requirements

Linux builds need a distribution with glibc 2.35 or newer, such as Ubuntu 22.04 or later.

Docker

The repository includes a Dockerfile and a docker-compose.yml for local trials and for platforms such as Dokploy.

git clone https://github.com/RadioPlatform/QuikCast.git
cd QuikCast

# Create the encoder password the Docker config expects
mkdir -p secrets.docker
openssl rand -hex 16 | tr -d '\n' > secrets.docker/radio-source
chmod 644 secrets.docker/radio-source

docker compose up --build

The container runs as a non-root user, so the secret file must be readable by others (chmod 644). The streaming port 8000 is published. The admin port 9090 stays inside the container on purpose; check health from inside it:

docker compose exec quikcast curl -fsS http://127.0.0.1:9090/health/live

Inside Docker the config must set listen = "0.0.0.0:8000", which config/quikcast.docker.toml already does. More on running containers in the production checklist.

Check your install

Whichever route you took, the next step is the same: write a small config and let Quikcast validate it without starting.

quikcast --config quikcast.toml --check

It prints configuration ok when everything is fine. The quickstart walks you through the file.