Install Peaksel

Specs

  • Operating System: Ubuntu with Docker installed. Windows is supported, but not recommended.

  • Required software: Docker and Docker Compose Plugin (see instructions below)

  • Authentication: if you have a corporate OAuth2 OpenID Connect server, Peaksel can use that. Otherwise, you can configure the user list in the configuration file.

Hardware requirements will depend mostly on how many users and how much data you have. You can start with the minimal

Minimum Optimal

CPU

1

8

RAM

2

16

Disk

HDD

SSD

Disk size

100GB

Depends on the amount of data you have

Installing on Ubuntu/Debian with Docker (recommended)

This instruction will guide you to install Peaksel as well as its database (PostgreSQL) as Docker containers. You may want to consider installing and managing database separately for production use.

  1. Install Docker using official docs on Ubuntu

  2. Run docker login on Ubuntu (email us and we’ll provide the credentials)

  3. Download and unzip Peaksel configs

  4. Edit docker-compose.yml and replace PEAKSEL_VERSION with a real version (which you should receive from us via email)

  5. Step into the folder in the terminal and run docker compose up -d

  6. Now you can open it in your browser: http://[ip-address-of-ubuntu-machine]:8080

Besides Peaksel itself, this starts Postgres DB inside as a Docker container too. If you want more scalable/reliable set up, you may want to consider setting up Postgres on a separate machine with backups & failover set ups. Or use cloud versions.

Installing on Windows w/o Docker (not recommended)

This isn’t a recommended option for production work and should be used only to evaluate Peaksel.

Before installing Peaksel itself we need to install its dependencies:

  1. Download latest Java (at the time of writing it was Java23), unzip it into one of your software folders, let’s say C:\Users\[your user]\Documents\elsci\. Your Java Home path should be something like this: C:\Users\[your user]\Documents\elsci\openjdk-23_windows-x64_bin\jdk-23.

  2. Download and install latest PostgreSQL. Remember which password you configured, choose locale English, United States.

Now install and configure Peaksel:

  1. Download and unzip Peaksel configs into C:\Users\[your user]\Documents\elsci

  2. Open peaksel.bat in notepad and edit first lines: specify where your Java location is, where PostgreSQL is installed and what was the password that you entered during Postgres installation.

  3. Download Peaksel from the URL that we provided in the email.

  4. Rename it to peaksel.jar and put it into C:\Users\[your user]\Documents\elsci

  5. Open Windows Command Line (press Cmd+R, enter cmd) and run

cd Documents\elsci
peaksel.bat

  1. In 30 seconds open http://localhost:8080 in browser

  2. To stop Peaksel press Ctrl+C in Command Line