mirror of
https://github.com/agersant/polaris
synced 2024-09-20 05:41:52 +00:00
No description
538b41a2b4
* Use standard Linux directories for application data (https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard) * Use standard system directories * Cleanup all Polaris files during uninstall * Expose get_pid_directory to rest of the crate * Add separate targets for install binary and data files, clean up makefile * Use environment variables for directory locations during install process * On Linux, read locations from environment variables at compile time * Split static_directory in two (web and swagger directories) * Follow recommendations from the Make manual * Avoid redundant directories * Added workflow to validate installer setup * Added CLI options to locate log file, pid file and cache directory * Fixed an issue where build command did not support the xdg/system switch * Renamed log option to log-level * Fixed an issue where xdg install would do a system build * Use re-usable action to make linux release * Avoid nested actions (see https://github.com/actions/runner/issues/646) * Updated installation instructions * Replaced deprecated use of set-env |
||
|---|---|---|
| .github | ||
| .vscode | ||
| docs | ||
| migrations | ||
| res | ||
| src | ||
| test-data | ||
| .codecov.yml | ||
| .gitignore | ||
| .rustfmt.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| diesel.toml | ||
| LICENSE | ||
| make_release.ps1 | ||
| README.md | ||
| update_db_schema.bat | ||
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,oggandopusfiles - Support for album art images
- Last.fm scrobbling
- Color themes
- Restrict access to your music collection with user accounts
Tutorials
Screenshots
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.