Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 3.97 KB

README.md

File metadata and controls

71 lines (51 loc) · 3.97 KB

Actions Status codecov License: MIT

Polaris Web UI

About

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

Try It Out!

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

Username: demo_user
Password: demo_password

Features

  • 🖥️ Runs on Windows, Linux, BSD, or through Docker
  • 🔊 Support for flac, mp3, mp4, mpc, ogg, opus, ape, wav and aiff 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:

Installation

Installation documentation

Streaming from remote devices

Packaging status

Documentation

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

Credits & License Information

Music featured in the demo installation: