Getting started

Demo server

Before setting up the server yourself, you can try out the client using the demo server. You will still need to install the client, after which you can use the demo user with username demo and password Demo1! which has some sample data.


Gnomeshade can be downloaded from A nightly version is also available, however it is not recommended to use it in production systems. Some features might not work, and there might not be an update path to future versions.

Installing the server

Installing on Debian/Ubuntu

  1. Download the DEB package from the release
  2. Install the package:
    sudo dpkg -i gnomeshade.deb
  3. Configure the admin user and database
  4. Start the server:
    sudo systemctl restart gnomeshade
  5. The server should be available on http://localhost:5000, and http://localhost:5000/api/v1.0/health should return Healthy

Installing on Docker

  1. Download the example docker-compose.yml file
  2. Configure the admin user and database
  3. Start the server:
    docker-compose up --detached
  4. The server should be available on http://localhost:8080/, and http://localhost:8080/api/v1.0/health should return Healthy

Create a user account

Before you can start using Gnomeshade, first you must create an account for yourself.
  1. Either go to the home page http://localhost:8080/ click "Register" in the top right corner, or go to the registration page http://localhost:8080/Identity/Account/Register
  2. Depending on your configuration either create a new account with a username/password, or register using an external identity provider

Installing the client

Installing on Windows

  1. Download the MSI installer from the release
  2. Run the installer
  3. Run Gnomeshade
  4. On first run you will be prompted for some configuration:
    1. The address of the server, by default http://localhost:8080/
    2. Optionally, you can provide the configuration for an external identity provider
  5. Log in with the account you created before