polaris/README.md
2022-11-14 00:46:14 -08:00

3 KiB

Actions Status codecov.io License: MIT

Polaris is a music streaming application, designed to let you enjoy your music collection from any computer or mobile device. Polaris works by streaming music directly from your computer (or cloud server), without uploading it to a third-party. It is free and open-source software, without any kind of premium version.

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

Polaris Web UI

  • Optimized for large music collections
  • Can run on Windows, Linux, BSD, or through Docker
  • Support for flac, mp3, mp4, mpc, ogg, opus, ape, wav and aiff files
  • Easy to setup and administer, no configuration files needed
  • Dark mode and customizable color themes
  • Listen to your music on the go with Polaris Android
  • Last.fm scrobbling

Tutorials

Documentation

API Documentation

The Polaris server API is documented via Swagger. Every installation of Polaris distributes this documentation, with the ability to use the Try it out buttons. To access it, simply open http://localhost:5050/swagger/ in your browser on the machine running Polaris.

Credits & License Information

Music featured in the demo installation: