Prerequisites

Portrait is shipped as a container and can be downloaded via Docker Hub. Furthermore, docker-compose is used for managing additional images. Before you can execute the following steps, you need a Docker environment, including docker-compose.

If you don’t have a docker environment yet – check out this article: Run Portrait on a hypervisor

We only provide Docker Containers for Linux, therefore this guide covers the way how to install Portrait on Linux. If you want to run Portrait on Windows, see Install Portrait on Windows

Components

Portrait contains multiple components:

• Docker image for the Backend https://hub.docker.com/r/treskon/portrait

• Docker image for the Frontend https://hub.docker.com/r/treskon/portrait-ui

• Docker image for the Scripting-Engine https://hub.docker.com/r/treskon/portrait-pythonruntime

• Configuration files

All released versions can be found here:Release Notes

Install the latest stable version

We offer an express installer that can be executed in the Terminal. Execute this command in the desired install location:

This installer will guide you through the required steps to have a Portrait instance up and running, expect the following questions whilst running the setup:

1. What will be the name of your app?

2. Who is maintaining and running the app?

3. If you want to include demo data.

4. What is the address under which the app will be accessible?
   If you run a local development instance, you can use the default value: http://localhost.
   If you plan to expose this instance, you need to define the external URL.

5. What is the internal TCP port of the app?

6. Login and password for the administrator – the user must be an email-address.

Configure Portrait

After you have installed the instance and logged in with your administrator account, you can start customizing and configuring the app.

Details on Configuration can be found here: Configuration