Setup guide tweaks

This commit is contained in:
Antoine Gersant 2024-10-13 00:24:10 -07:00
parent c640086a3e
commit ed546ed531
2 changed files with 11 additions and 15 deletions

View file

@ -26,13 +26,14 @@ Password: `demo_password`
- Polarios ([App Store](https://apps.apple.com/app/polarios/id1662366309) · [Repository](https://gitlab.com/elise/Polarios))
- [Last.fm](https://www.last.fm) scrobbling
## Tutorials
## Setup Guide
- [Getting Started](docs/SETUP.md)
- [Installation](docs/SETUP.md)
- [Streaming From Remote Devices](docs/DDNS.md)
## Documentation
- [Changelog](CHANGELOG.md)
- [Configuration](docs/CONFIGURATION.md)
- [Contribute to Polaris](docs/CONTRIBUTING.md)
- [Maintenance Runbooks](docs/MAINTENANCE.md)

View file

@ -1,26 +1,21 @@
# Getting Started
# Installation
## Requirements
One of the following:
- Windows 7 or newer
- Linux (any reasonably modern distribution should do)
### Windows
## Windows
1. Download the [latest installer](https://github.com/agersant/polaris/releases/latest) (you want the .msi file)
2. Run the installer
3. Launch Polaris from the start menu
4. In your web browser, access http://localhost:5050
### Linux
## Linux
#### Dependencies
### Dependencies
1. Install OpenSSL, SQLite and their headers, and some development tools. These are available from your distribution's package manager. For instance on Ubuntu, execute `sudo apt-get install binutils pkg-config libssl-dev`
1. Install OpenSSL, SQLite and their respective headers (eg. `sudo apt-get install libsqlite3-dev libssl-dev`).
2. Install `binutils` and `pkg-config` (eg. `sudo apt-get install binutils pkg-config`).
2. Install the Rust compiler by executing `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` or using an [alternative method](https://www.rust-lang.org/en-US/install.html)
#### Polaris installation
### Polaris installation
1. Download the [latest release]((https://github.com/agersant/polaris/releases/latest)) of Polaris (you want the .tar.gz file)
2. Extract the Polaris archive in a directory and open a terminal in that directory
3. To install Polaris within your home directory, execute `make install-xdg`. This installation follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html). You can use `make preview-xdg` to see which directories the install process would use.
@ -30,6 +25,6 @@ From here, you might want to adjust your system to run Polaris on login using Sy
If you want to uninstall Polaris, execute `make uninstall-xdg` from the extracted archive's directory (or `make uninstall` if you made a system-wide install). This will delete all the files and directories listed above (including your configuration, playlists, etc.). If you customized the install process by specifying environment variables like `PREFIX`, make sure they are set to the same values when running the uninstall command.
### In a docker container
## In a docker container
To run polaris from a Docker container, please follow instructions from the [docker-polaris](https://github.com/ogarcia/docker-polaris) repository.