Quickstart

To quickly try out sharry, follow these steps:

  1. Download a zip (version 1.11.0) from the release page.
  2. Unpack it to some place.
    $ unzip sharry-restserver-1.11.0.zip
    
  3. Run the executable:
    $ /path/to/extracted-zip/bin/sharry-restserver
    
  4. Goto http://localhost:9090/, signup and login

If you want to know more, for example what can be configured, checkout these pages.

Quickstart with Docker

There is a docker-compose setup available in the /docker folder.

  1. Clone the github repository
    $ git clone https://github.com/eikek/sharry
    
  2. Change into the docker directory:
    $ cd sharry/docker
    
  3. Run docker-compose up:
    $ docker-compose up
    
  4. Goto http://localhost:9090/, signup and login

The directory contains a file sharry.conf that you can modify as needed.