Lurcast docs
Lurcast is an internet radio streaming server, compatible with Icecast and SHOUTcast encoders, players and admin tools. The core is open source. The Hosting edition adds what a stream hosting company needs to run many customer stations in one process.
Open-source core
- Getting startedInstall the open-source Lurcast server, give it a minimal configuration, send it a stream and listen.
- Configuration referenceEvery setting in config.yml for the open-source core, with its default and its environment variable.
- Admin dashboard and status pageWatch listeners live and over time, change song titles and fallbacks, and move, disconnect or ban listeners from the built-in web dashboard.
- OperationsReload the configuration without a restart, keep an access log, offer HLS, record mounts to disk, send webhooks, chart listener history and ban listeners.
- Encoders and compatibilityWhich sources, players, admin tools and directories Lurcast works with, and the Icecast- and SHOUTcast-compatible endpoints it serves.
Hosting edition
- Install the Hosting editionDownload the Hosting edition binary with your license key, run it with Docker or systemd, and configure the hosting section.
- Licensing and renewalHow Hosting edition license keys work, what happens when one expires, and how keys renew on their own.
- Provisioning APICreate, change, suspend and delete customer stations at runtime, and read usage and royalty reports, over a JSON API.
- Metrics, reports and locationsScrape per-station Prometheus metrics, export the listener sessions and song plays that royalty collecting societies ask for, and see which countries listeners are in.
- WHMCS moduleSet up stations automatically from WHMCS orders, with suspension, plan changes and monthly bandwidth usage.