Mirrors/polaris
2
0
Fork 0
mirror of https://github.com/agersant/polaris synced 2024-11-10 10:14:12 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
787 commits 5 branches 33 tags 22 MiB
PostScript 94.7%
Rust 5.1%
Find a file
Antoine Gersant d8f38e88f0 Fixed dead link
2020-08-27 02:01:19 -07:00
.github/workflows Tentative fix for CI breakage 2020-06-13 19:24:47 -07:00
.vscode Autoformat 2019-09-02 13:12:48 -07:00
docs Sidestep github pages 2020-08-27 02:00:22 -07:00
migrations Added preference fields for web theme 2020-01-11 01:58:22 -08:00
res Cleaned up README (#93) 2020-08-27 01:39:50 -07:00
src properly export and use the match macro 2020-08-07 15:03:36 +02:00
test make case insensitivity mandatory for the tests to pass 2020-08-07 12:54:07 +02:00
.gitignore Updated test config ignore 2020-02-01 20:38:33 -08:00
.rustfmt.toml Rustfmt 2018-10-06 16:30:21 -07:00
Cargo.lock add support for opus files 2020-08-06 17:26:50 +02:00
Cargo.toml order dependencies alphabetically 2020-08-07 12:45:43 +02: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 Fixed dead link 2020-08-27 02:01:19 -07:00
update_db_schema.bat Updated diesel dependency 2018-10-06 18:13:44 -07:00

README.md

Actions Status

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!

Key Features

  • Optimized for large music collections
  • Can run on Windows, Linux and BSD or through Docker
  • Listen to your music through 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.