diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 6d79b8f..06a4889 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,4 +1,6 @@ -# Compiling and Running Polaris +# Contributing + +## Compiling and Running Polaris Compiling and running Polaris is very easy as it only depends on the Rust toolchain. @@ -18,6 +20,6 @@ Putting it all together, a typical command to compile and run the program would While Polaris is running, access the web UI at [http://localhost:5050](http://localhost:5050). -# Running Unit Tests +## Running Unit Tests That's the easy part, simply run `cargo test`! diff --git a/docs/DDNS.md b/docs/DDNS.md index 0a5c0df..e75ca6f 100644 --- a/docs/DDNS.md +++ b/docs/DDNS.md @@ -1,4 +1,6 @@ -# Dynamic DNS +# Streaming From Other Devices + +## Dynamic DNS You can access your Polaris installation from anywhere via your computer's public IP address, but there are two problems with that: - IP addresses are difficult to remember @@ -33,7 +35,7 @@ The steps below will walk you through setting up YDNS and Polaris to give your i - Update the username field to the email address you use when creating your YDNS account - Update the password field with your YDNS API password. You can find this password on https://ydns.io: click on the "User" icon in the top right and then `Preferences > API`. -# Port Forwarding +## Port Forwarding Configure port forwarding on your router to redirect port 80 towards port 5050 on the computer where you run Polaris. The exact way to do this depends on your router manufacturer and model. Don't forget to restart Polaris to apply your configuration changes, and access your music from other computers at http://yourdomain.ydns.eu diff --git a/docs/MAINTENANCE.md b/docs/MAINTENANCE.md index 14b3fc9..af64163 100644 --- a/docs/MAINTENANCE.md +++ b/docs/MAINTENANCE.md @@ -1,4 +1,6 @@ -# How to make a release +# Maintenance + +## How to make a release - `git pull` to not miss out on any recent contributions - Update version number in Cargo.toml and commit the change (no need to push) @@ -8,7 +10,7 @@ Note that the Github web UI will separate the release from the corresponding tag until published. -# How to change the database schema +## How to change the database schema - Add a new folder under `migrations` following the existing pattern - Run `update_db_schema.bat` (all its should also work in bash if you're a Linux user) diff --git a/docs/SETUP.md b/docs/SETUP.md index f629866..45eaed0 100644 --- a/docs/SETUP.md +++ b/docs/SETUP.md @@ -1,26 +1,28 @@ -# Requirements +# Getting Started + +## Requirements One of the following: - Windows 7 or newer - Linux (any reasonably modern distribution should do) -# Installation +## Installation -## Windows +### Windows 1. Download the [latest installer](https://github.com/agersant/polaris/releases/latest) (you want the .msi file) 2. Run the installer 3. That's it, you're done! You can now start Polaris from the start menu or from your desktop, Polaris will also start automatically next time you restart your computer. You can tell when Polaris is running by its icon in the notification area (near the clock and volume controls). -## 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 libsqlite3-dev` 2. Install the nightly Rust compiler by executing `curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly` 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. Execute `make install` (this may take several minutes) @@ -31,11 +33,11 @@ From here, you might want to adjust your system to run Polaris on login using Cr If you want to uninstall Polaris, execute `make uninstall` from the extracted archive's directory. This will simply delete the directories created by the install process. -## 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. -# Try it out! +## Test Run - Start Polaris using the shortcut on your desktop (Windows) or by running the executable in `~/.local/bin/polaris` (Linux) - In your Web browser, access http://localhost:5050