Getting Started

Requirements

One of the following:

Windows 7 or newer
Linux (any reasonably modern distribution should do)

Installation

Windows

Download the latest installer (you want the .msi file)
Run the installer
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

Dependencies

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
Install the nightly Rust compiler by executing curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly or using an alternative method

Polaris installation

Download the latest release of Polaris (you want the .tar.gz file)
Extract the polaris archive in a directory and open a terminal in that directory
Execute make install (this may take several minutes)

This installation process puts the polaris executable in ~/.local/bin/polaris and several data files under ~/.local/share/polaris.

From here, you might want to adjust your system to run Polaris on login using Cron, Systemd or whichever method your distribution endorses.

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

To run polaris from a Docker container, please follow instructions from the docker-polaris repository.

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
You will see a welcome page that will guide you through the Polaris configuration

2.2 KiB Raw Blame History