Repository files navigation

Polaris is a self-hosted music streaming server, to enjoy your music collection from any computer or mobile device. It is free and open-source software, without any kind of premium version.

The goals of this project are:

• 🔥 Exceptional performance and responsiveness
• 📚️ First-class support for large music collections (100,000+ songs)
• 📦️ Ease of installation, deployment and maintenance
• ✨ Beautiful user interface

Check out the demo over athttps://demo.polaris.stream, featuring a selection of Creative Commons Music. The credentials to access this server are:

Username:demo_user
Password:demo_password

• 🖥️ Runs on Windows, Linux, BSD, or through Docker
• 🔊 Support forflac,mp3,mp4,mpc,ogg,opus,ape,wav andaiff files
• 🌈 Dark mode variants and customizable color palette
• 💿️ Browse your music by album, artist or genre
• 📂 Browse your music as a file tree
• 🌊 Song audio-waveform visualization
• 🏷️ Support for multi-value fields in song metadata (eg. multiple artists per song)
• 🔍️ Powerful search functionality with per-field queries
• ⚙️ Plain-text configuration also editable with built-in UI
• 👥 Setup multiple users, each with their own playlists
• 📱 Listen to your music on the go:
  • Polaris Android (Google Play Store ·F-Droid ·Repository)
  • Polarios (App Store ·Repository) [third-party]

Installation documentation

Streaming from remote devices

• 📒Changelog
• 🔧Configuration
• 👷Contribute to Polaris
• 🛟Maintenance Runbooks

The Polaris server API is documented viaOpenAPI. Every installation of Polaris distributes this interactive documentation. To access it, openhttp://localhost:5050/api-docs/ in your browser on the machine running Polaris.

Music featured in the demo installation:

• Chris Zabriskie - Abandon Babylon(License)
• Chris Zabriskie - Angie's Sunday Service(License)
• glaciære - pool water blue(License)
• glaciære - light ripples(License)
• Koresma South(License)
• Pete Murphy - Essence EP(License)
• Rameses B - Essence EP(License)