Browse documentation
Documentation for v0.14.0View original source ↗

Native installation

🐧   Linux
# 1. Install prerequisites (Debian / Ubuntu)
sudo apt install -y git ffmpeg python3 python3-venv python3-pip nodejs npm

# 2. Get Soundsible
git clone https://github.com/Arzuparreta/soundsible.git
cd soundsible

# 3. Install web player deps (one-time; dist builds on engine start)
cd ui_web && npm ci && cd ..

# 4. Run it
python3 run.py

Check node --version: you need Node.js 22 or newer. If your distribution ships an older version, install a current Node.js release before npm ci.

Other distros — swap step 1:

  • Arch: sudo pacman -S git ffmpeg python python-pip nodejs npm
  • Fedora: sudo dnf install git ffmpeg python3 python3-pip nodejs npm
🍎   macOS

Requires Homebrew.

# 1. Install prerequisites
brew install git ffmpeg python node

# 2. Get Soundsible
git clone https://github.com/Arzuparreta/soundsible.git
cd soundsible

# 3. Install web player deps (one-time; dist builds on engine start)
cd ui_web && npm ci && cd ..

# 4. Run it
python3 run.py
🪟   Windows

In PowerShell:

# 1. Install prerequisites
winget install Git.Git Python.Python.3.12 Gyan.FFmpeg OpenJS.NodeJS.LTS

# 2. Close and reopen PowerShell so the new tools are on PATH, then:
git clone https://github.com/Arzuparreta/soundsible.git
cd soundsible

# 3. Install web player deps (one-time; dist builds on engine start)
cd ui_web; npm ci; cd ..

# 4. Run it
python run.py

No winget? Install Git, Python (tick “Add to PATH”), Node.js (LTS), and FFmpeg manually.

On Windows, type python wherever this guide says python3.

First run

The first python3 run.py creates the project virtualenv, installs Python dependencies and, because nothing is configured yet, starts the setup page instead of the menu. Open http://localhost:5099/setup, choose where your music lives and save. Go back to the launcher page and click Launch to start the engine, then open http://localhost:5005/player/. Keep the terminal open while you listen.

To reopen setup later, run python3 run.py --setup.

Every run after that

python3 run.py opens the terminal menu:

KeyDoes
1Start the engine and open the player in your browser
2Start the engine without opening a browser
3Open the player (the engine must already be running)
4Stop the engine
5Search your library from the terminal
6Open the setup page again
qQuit — this also stops the engine the menu started

The menu is for a session at your computer: keep its terminal open while you listen.

You do not need the menu. To run the engine without it — on a server, in tmux, or under systemd — use --daemon:

python3 run.py --daemon   # Ctrl+C stops it

Running on a server covers that mode and the systemd service. Prefer a browser panel to the terminal? Run ./venv/bin/python start_launcher.py (on Windows, .\venv\Scripts\python start_launcher.py), open http://localhost:5099 and click Launch.

Search documentation