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
864 commits 5 branches 33 tags 22 MiB
PostScript 94.7%
Rust 5.1%
Find a file
Antoine Gersant 7a73ae7cc0 Don't emit log file when running in foreground (-f on Linux, polaris-cli.exe on Windows) and --log is not set
2021-01-02 16:03:51 -08:00
.github Checkout release branch when making a release 2020-12-30 22:56:26 -08:00
.vscode Autoformat 2019-09-02 13:12:48 -07:00
docs Support for bearer token authentication (#120) 2020-12-20 03:25:45 -08:00
migrations Adds jpeg to default album art filter 2020-12-15 01:32:58 -08:00
res Platform-specific improvements (#127) 2020-12-30 21:41:57 -08:00
src Don't emit log file when running in foreground (-f on Linux, polaris-cli.exe on Windows) and --log is not set 2021-01-02 16:03:51 -08:00
test-data Split configuration module (#117) 2020-12-18 01:14:24 -08:00
.codecov.yml Codecov settings 2020-09-24 01:51:29 -07:00
.gitignore Platform-specific improvements (#127) 2020-12-30 21:41:57 -08:00
.rustfmt.toml Rustfmt 2018-10-06 16:30:21 -07:00
build.rs Platform-specific improvements (#127) 2020-12-30 21:41:57 -08:00
Cargo.lock Platform-specific improvements (#127) 2020-12-30 21:41:57 -08:00
Cargo.toml Platform-specific improvements (#127) 2020-12-30 21:41:57 -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
README.md Added license badge 2020-12-12 15:31:41 -08:00
rust-toolchain Replace rocket with actix-web (#116) 2020-12-14 21:18:44 -08:00
update_db_schema.bat Updated diesel dependency 2018-10-06 18:13:44 -07:00

README.md

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 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.