Skip to content

Installation using Docker

Jump to bottom
matamorphosis edited this page Jan 9, 2023 · 9 revisions

License: GPL v3

Support

Support for Scrummage installations is provided for tier 3 and 4 monthly sponsors, and ad-hoc support is provided based on the relevant time-limit. For more details, you can contact us via the sponsors page.

Installation using Docker

PLEASE FOLLOW CAREFULLY AS THERE IS INFORMATION PRINTED IN THE TERMINAL THAT WILL NEED TO BE RETAINED

Docker automates almost the entire installation process and doesn't give you the choice of OS, Ubuntu 20.04 is the current distribution used.
If you want a more in depth understanding of the installation steps, please check out the Wiki page here
This guide assumes you have docker installed on your system already and know the essentials of docker and how its virtualised environments work.

Notes

  1. It is recommended that you change configuration for things like API keys, via the "Edit Inputs", "Edit Outputs", and "Edit Core" functions on the settings page.
  2. For those that are new to docker, running "docker run..." creates a new container, so all changes will be lost after the build. Use "docker attach" to not overwrite changes.
  3. Unlike the regular installation of Scrummage, the IP address displayed on run is not the IP address you access Scrummage from. This is because Scrummage is running in a Docker container on your host in a virtualised network. This network uses network address translation (NAT) and the docker run command below maps the internal port 5000 in your virtualised environment to port 5000 on your host so you can access it. You need to access Scrummage using the NAT IP address. If running Docker on a Linux host you can use the ifconfig or the ip addr command to find the Docker IP address on your host, that will be the IP address used to access Scrummage.

Option 1: Using the package link

  1. Navigate to the package link here, and follow the command displayed under "Install from the command line", for reference the command is listed below:
user@linux:~$ docker pull ghcr.io/matamorphosis/scrummage:latest
  1. As the package is pre-built, bring up the container using the docker run command and take note of the admin password. (This password is randomly and automatically generated in a secure manner, it is only displayed on the first run of the container, after which is destroyed for obvious security reasons). This password can be changed via the settings page after logging in, but this step is not required.
user@linux:~$ docker run -p 5000:5000 ghcr.io/matamorphosis/scrummage:latest
---EXAMPLE OUTPUT---
 * Restarting PostgreSQL 12 database server
   ...done.
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0

----------------------------------------------------------------------------------------------------
This is the admin password, this will only be displayed on the first run of Scrummage:
<PASSWORD WILL BE DISPLAYED HERE>
----------------------------------------------------------------------------------------------------
...
  1. Find your docker container's IP address through using either the ifconfig or ipconfig command. Then navigate to https://:5000, accept the certificate (if using self-signed), and log in with the user admin and the password provided to you in the previous step.

Option 2: Using the docker-compose.yml file included in this repository

  1. If not done already, navigate to the Docker Installation directory
user@linux:~$ cd Scrummage/installation/docker
  1. Bring up container using the following command and take note of the admin password. (This password is randomly and automatically generated in a secure manner, it is only displayed on the first run of the container, after which is destroyed for obvious security reasons). This password can be changed via the settings page after logging in, but this step is not required.
user@linux:/<PATH-TO-SCRUMMAGE>/installation/docker$ docker-compose up
---EXAMPLE OUTPUT---
 * Restarting PostgreSQL 12 database server
   ...done.
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0

----------------------------------------------------------------------------------------------------
This is the admin password, this will only be displayed on the first run of Scrummage:
<PASSWORD WILL BE DISPLAYED HERE>
----------------------------------------------------------------------------------------------------
...
  1. Find your docker container's IP address through using either the ifconfig or ipconfig command. Then navigate to https://:5000, accept the certificate (if using self-signed), and log in with the user admin and the password provided to you in the previous step.

Option 3: Using the Dockerfile included in this repository

  1. If not done already, navigate to the Docker Installation directory
user@linux:~$ cd Scrummage/installation/docker
  1. Build the docker image
user@linux:/<PATH-TO-SCRUMMAGE>$ docker build -t scrummage:latest .
  1. Run the container and take note of the admin password. (This password is randomly and automatically generated in a secure manner, it is only displayed on the first run of the container, after which is destroyed for obvious security reasons). This password can be changed via the settings page after logging in, but this step is not required.
user@linux:~$ docker run -p 5000:5000 scrummage/latest
---EXAMPLE OUTPUT---
 * Restarting PostgreSQL 12 database server
   ...done.
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0

----------------------------------------------------------------------------------------------------
This is the admin password, this will only be displayed on the first run of Scrummage:
<PASSWORD WILL BE DISPLAYED HERE>
----------------------------------------------------------------------------------------------------
...
  1. Find your docker container's IP address through using either the ifconfig or ipconfig command. Then navigate to https://:5000, accept the certificate (if using self-signed), and log in with the user admin and the password provided to you in the previous step.

Tasks and APIs

Refer to the Wiki Page https://github.com/matamorphosis/Scrummage/wiki/The-Long-List-of-Tasks

Output Alert Options

Refer to the Wiki Page https://github.com/matamorphosis/Scrummage/wiki/Output-Options

Setting up Your First Task

Refer to the Wiki Page https://github.com/matamorphosis/Scrummage/wiki/Getting-Started-after-Installation

Building Your First Custom Task (Developers Only)

Refer to the Wiki Page https://github.com/matamorphosis/Scrummage/wiki/Plugin-Development-Guide

Clone this wiki locally