Skip to main content

Volumio Logo banner

Welcome to Volumio's Developers Documentation!

Volumio is a free and Open Source Linux Distribution, designed and fine-tuned exclusively for music playback. It runs on a variety of devices, typically small and cheap computers like the Raspberry PI, but also on low power PCs, notebooks or thin clients. By flashing (installing) Volumio on any of these platforms, it will become a headless Audiophile Music Player. Headless means that the only way to control it will be with another device - a mobile phone, computer or tablet.

This is made possible by Volumio’s UI: a web application that runs on any device with a web browser, that allows an easy and intuitive control of your playback sessions. All communications between the webapp and Volumio will happen through your home network. To learn more about Volumio, see the Discover Page or Technical Overview Page on the Volumio website and the documentation site.

This documentation is aimed to help both users and developers, any contribution is welcome to make it better.

API

Explore Volumio's APIs:
Websocket API Reference
HTTP REST API
Command Line Interface

PLUGINS

Extend Volumio functionality via plugins:
Plugin System Introduction
Plugin Command Line Utility
Publish your plugin
Publish submission checklist

PORTING GUIDE

Devices porting guide
Kernel Requirements