No description
Find a file
Antoine Gersant 0e52047417 Fixed typo
2020-12-07 23:31:05 -08:00
.github Pin rust toolchain version (#108) 2020-12-07 22:08:37 -08:00
.vscode Autoformat 2019-09-02 13:12:48 -07:00
docs Pin rust toolchain version (#108) 2020-12-07 22:08:37 -08:00
migrations Removed support for prefix_url 2020-11-25 17:49:18 -08:00
res Include toolchain file in release tarball 2020-12-07 22:29:34 -08:00
src Fixed typo 2020-12-07 23:31:05 -08:00
test-data More accurate teste for web client serving 2020-12-06 02:48:42 -08:00
.codecov.yml Codecov settings 2020-09-24 01:51:29 -07:00
.gitignore Rewrote indexer (#107) 2020-12-07 20:07:10 -08:00
.rustfmt.toml Rustfmt 2018-10-06 16:30:21 -07:00
Cargo.lock Bump base64 version 2020-12-07 23:30:51 -08:00
Cargo.toml Bump base64 version 2020-12-07 23:30:51 -08:00
diesel.toml Updated diesel dependency 2018-10-06 18:13:44 -07:00
LICENSE Initial commit 2016-08-14 01:28:45 -07:00
make_release.ps1 Tagging cleanup 2020-08-04 23:32:36 -07:00
README.md Codecov badge 2020-09-24 02:57:03 -07:00
rust-toolchain Pin rust toolchain version (#108) 2020-12-07 22:08:37 -08:00
update_db_schema.bat Updated diesel dependency 2018-10-06 18:13:44 -07:00

Actions Status codecov.io

Polaris is a music streaming application, designed to let you enjoy your music collection from any computer or mobile device. Polaris works by streaming your music directly from your own computer, without uploading it to a third-party. It is free and open-source software, without any kind of premium version. The only requirement is that your computer stays on while it streams music!

Features

  • Optimized for large music collections
  • Can run on Windows, Linux, BSD, or through Docker
  • Listen to your music on the web or using the Polaris Android app
  • Easy to setup and configure via the built-in web UI
  • Support for flac, mp3, mp4, mpc, ogg and opus files
  • Support for album art images
  • Last.fm scrobbling
  • Color themes
  • Restrict access to your music collection with user accounts

Tutorials

Screenshots

Polaris Web UI Polaris Web UI Dark Mode

Documentation

API Documentation

The Polaris server API is documented via Swagger. Please note that this Swagger page does not point to a live Polaris server so the Try it out buttons are not expected to work. Every installation of Polaris also 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.

Feel free to open Github issues or Pull Requests if clarifications are needed.