Mirrors/polaris
2
0
Fork 0
mirror of https://github.com/agersant/polaris synced 2024-09-20 05:41:52 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
885 commits 3 branches 32 tags 21 MiB
PostScript 94.7%
Rust 5.1%
Find a file
Antoine Gersant 2873f38e04 Merged trivial modules
2022-11-09 00:33:57 -08:00
.github Update codecov github action 2021-11-14 14:17:36 -08:00
.vscode Add few more fields to song information (#141) 2021-05-20 22:08:43 -07:00
docs Removed deprecated authentication methods 2022-11-08 02:01:20 -08:00
migrations Add few more fields to song information (#141) 2021-05-20 22:08:43 -07:00
res Platform-specific improvements (#127) 2020-12-30 21:41:57 -08:00
src Merged trivial modules 2022-11-09 00:33:57 -08:00
test-data Add few more fields to song information (#141) 2021-05-20 22:08:43 -07:00
.codecov.yml Codecov settings 2020-09-24 01:51:29 -07:00
.gitignore add api parameter for thumbnail size (#144) 2021-06-05 02:24:25 -07: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 Removed deprecated authentication methods 2022-11-08 02:01:20 -08:00
Cargo.toml Removed deprecated authentication methods 2022-11-08 02:01:20 -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 Updated list of supported formats 2021-04-27 21:43:28 -07: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, opus, ape, wav and aiff 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.