/
/
/
1Music Assistant
2==================================
3
4**Music Assistant Server**
5
6[](https://app.codspeed.io/music-assistant/server?utm_source=badge)
7
8Music Assistant is a free, opensource Media library manager that connects to your streaming services and a wide range of connected speakers. The server is the beating heart, the core of Music Assistant and must run on an always-on device like a Raspberry Pi, a NAS or an Intel NUC or alike.
9
10**Documentation and support**
11
12Documentation https://music-assistant.io
13
14Beta Documentation https://beta.music-assistant.io
15
16For issues, please go to [the issue tracker](https://github.com/music-assistant/support/issues).
17
18For feature requests, please see [feature requests](https://github.com/music-assistant/support/discussions/categories/feature-requests-and-ideas).
19
20____________
21
22
23## Running the server
24
25Music Assistant can be operated as a complete standalone product but it is actually tailored to use side by side with Home Assistant, it is meant with automation in mind, hence our recommended installation method is to run the server as a Home Assistant app.
26
27
28### Supported installation methods
29
30The only officially supported ways to run the Music Assistant server are:
31
32- **Home Assistant app** (recommended) â see https://music-assistant.io/installation/
33- **Docker container** â `ghcr.io/music-assistant/server`
34
35Both bundle every system dependency the server needs. Although Music Assistant's main code is Python, it depends on external/OS components â a recent **ffmpeg (6.1+)** with a specific codec set, native libraries (e.g. jemalloc and CIFS/NFS client libraries) and a few bundled binaries â which a plain PyPI/`pip` install can't provide. The server is therefore **not published to PyPI**; run it via the app or container above.
36
37[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge
38[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fmusic-assistant%2Fhome-assistant-addon
39
40### Running from source (development)
41
42For local development you provide the system dependencies yourself â **Python 3.14+** and **ffmpeg 6.1+** are required.
43
44- `scripts/setup.sh` â create the virtualenv and install dependencies and pre-commit hooks
45- `python -m music_assistant --log-level debug` â run the server locally (listens on http://localhost:8095)
46- `pytest` runs the tests; `pre-commit run --all-files` runs the linters
47
48---
49
50[](https://www.openhomefoundation.org/)
51