Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Vimeo
URLhttps://player.vimeo.com/video/254218077

 

In this guide we'll run you through installing the PI-Server application using the Linux Docker installer.

This is the most straightforward way to get your PI-Server up and running on a Linux server. If you know your ways with Docker and Unix, you most certainly be able to install it on macOS to.

Architectural overview

The PI-Server consists of multiple micro-services (crossbar, authserver, pi-admin...). With the help of Docker it is easy to orchestrate all services and link them together. In front of this services there is an nginx-container acting as a reverse proxy. This allows to access the services under convenient URL's. if you use encryption (TLS) the proxy is also in charge of decrypting the traffic as the communication behind the proxy is unencrypted.

Installation of PI-Server

Satisfying the requirements

Hardware

Suggested hardware requirements:

  • RAM: 2 GBytes
  • Hard-disk space: 10GB
  • CPU: at least one (v)-CPU (~ 2Ghz)

Docker

You need docker and docker-compose (compose-file version >=2.0) installed on your Linux system in order to run our containers.
Consult the Docker documentation for instructions on how to do that. https://docs.docker.com/engine/installation/

Python 

You need to have Python installed on your host system. Version 2.7. 

Get access to the Rentouch Docker repository

Internet: If you have access to the internet from your server, you can use our docker hub to fetch all the images automatically.

Info

Request a login (username and password) for the Rentouch-Docker-Hub from Rentouch if you do not already have one.

Code Block
docker login harbor.piplanning.io

 

No Internet: If you do not have access to the internet, you can download the images in a .tar file. Make sure you download the one which is matching the version of the installer. If there is no matching docker-images .tar available, please contact us directly as we only update the images archive manually.

  • Download the archive to a computer with internet access.
  • Move the .tar archive to the server on which you are installing pi-server.
  • Input the command: (this may takes a minute...)
  • Code Block
    docker load -i pi-server-images_1.1.0.tar

Downloading the PI-Server installer

Download the installer package from https://binaries.rentouch.ch/on-premise/ by: 

Code Block
wget https://binaries.rentouch.ch/on-premise/pi-server-docker_1.1.0.tar
(On macOs you can use: 'curl https://binaries.rentouch.ch/on-premise/pi-server-docker_1.1.0.tar -o pi-server-docker_1.0.10.tar')

You can then unpack the archive:

Code Block
mkdir pi-server-docker && tar -xf pi-server-docker_1.1.0.10.tar -C pi-server-docker

Enter the pi-server-docker folder

Code Block
cd pi-server-docker

Basic server configuration

You will find a file called piplanning.cfg in the installer folder. Please modify this file with your favorite editor (example vim or nano). 

Info

It is mandatory to set the hostname in the piplanning.cfg file as you can not use the server on localhost only. The desktop Apps and Jira (webhook) rely on an accessible PI-Server. You can also use your servers IP-Address instead of a hostname.

  • Change the hostname field to your hostname or IP
  • Change the backend password to a random string
  • If you want to use encrypted communication please refer here.

Run the installer and launch the Docker containers

When you have altered and saved the piplanning.cfg file you can start the containers by:

Code Block
./install.sh
Info

You can re-run the install.sh command to restart the server (containers) at anytime. You need to re-run install.sh after you have changed something in the piplanning.cfg.

Configure the PI-Server via the web-interface

At the end of install.sh you will get the URL which points to the set. It should look like: http(s)://<hostname>/setup.
Navigate to this URL in your browser and fill out the form.

Info

You can not change the company name once you have it initially set up.

Install your license

After you have pressed "go" you will be directed to the PI-Admin front-end. Please log yourself in with the credentials you entered on the setup page before.

Next navigate to the settings-page in the top menu. 

To receive a license, please send your ServerID (1) to service@rentouch.ch. We then will send you the license-key which you can paste into the input-field (2) and press Update.

Create Teams

Please refer to http://howto.rentouch.ch/pages/viewpage.action?pageId=2064797

Connect to your on-premise server from the Desktop-App

Please refer to Connect to your on-premise server from the desktop-app

Setup webhook from Jira

Test if your webhook URL is working by entering it into the browser. It should tell you something like: This is a listening Webook end of: <company-name>.

You will find the URL in pi-admin under the ALM-Settings or it gets you displayed after start.sh. It has to be of the format:

Code Block
http(s)://<hostname>/jira-endpoint/<company-name>

Further info on administrating the PI-Server

Please refer to Installation of PI-Server with Docker on Linux

piplanning app



Table of Contents
outlinetrue

 


Related to this guide

Page Tree
rootInstallation Self-hosted