vikarti.anatra/polaris-mirror
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
mirror of https://github.com/agersant/polaris
1189 commits 3 branches 34 tags 26 MiB
Find a file
Antoine Gersant cf5d1b7931 - Adds project goals 
- Updates feature list
- Readme polish
2025-02-02 00:49:59 -08:00
.github Tarpaulin -> grcov 2025-01-31 00:33:39 -08:00
.vscode Add few more fields to song information () 2021-05-20 22:08:43 -07:00
docs Working utoipa setup 2025-01-15 23:07:47 -08:00
res Adds example cover arts 2025-02-01 23:42:09 -08:00
src Fixed a bug where tray icon didnt appear on Windows 2025-02-02 00:01:28 -08:00
test-data Use small-collection dataset for migration unit tests 2025-01-31 16:55:37 -08:00
.codecov.yml Make patch test coverage informational 2022-11-24 20:38:19 -08:00
.envrc Dev environment setup 2024-07-27 13:30:42 -07:00
.gitignore Playlist migration 2025-01-09 21:59:59 -08:00
.rustfmt.toml Rustfmt 2018-10-06 16:30:21 -07:00
build.rs Dependency bumps 2024-07-13 19:01:06 -07:00
Cargo.lock Migrate to native_db 0.8.1 2025-01-16 00:14:53 -08:00
Cargo.toml Migrate to native_db 0.8.1 2025-01-16 00:14:53 -08:00
CHANGELOG.md Slightly more info on migration process 2025-01-31 19:25:12 -08:00
flake.lock Flake update 2025-01-13 20:06:11 -08:00
flake.nix WIP 2024-10-06 23:12:57 -07:00
LICENSE Initial commit 2016-08-14 01:28:45 -07:00
README.md - Adds project goals 2025-02-02 00:49:59 -08:00
rust-toolchain.toml Rename toolchain file 2024-07-27 22:20:27 -07:00

README.md

Actions Status codecov License: MIT

Polaris Web UI

About

Polaris is a self-hosted music streaming server, to enjoy your music collection from any computer or mobile device. It is free and open-source software, without any kind of premium version.

The goals of this project are:

  • 🔥 Exceptional performance and responsiveness
  • 📚️ First-class support for large music collections (100,000+ songs)
  • 📦️ Ease of installation, deployment and maintenance
  • ✨ Beautiful user interface

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

  • 🖥️ Runs on Windows, Linux, BSD, or through Docker
  • 🔊 Support for flac, mp3, mp4, mpc, ogg, opus, ape, wav and aiff files
  • 🌈 Dark mode variants and customizable color palette
  • 💿️ Browse your music by album, artist or genre
  • 📂 Browse your music as a file tree
  • 🌊 Song audio-waveform visualization
  • 🏷️ Support for multi-value fields in song metadata (eg. multiple artists per song)
  • 🔍️ Powerful search functionality with per-field queries
  • ⚙️ Plain-text configuration also editable with built-in UI
  • 👥 Setup multiple users, each with their own playlists
  • 📱 Listen to your music on the go:

Installation

Installation documentation

Streaming from remote devices

Packaging status

Documentation

The Polaris server API is documented via OpenAPI. Every installation of Polaris distributes this interactive documentation. To access it, simply open http://localhost:5050/api-docs/ in your browser on the machine running Polaris.

Credits & License Information

Music featured in the demo installation: