timpiltd/timpi-guardian repository overview

Timpi Guardian Node Docker Installation The following installation description has been tested on Ubuntu 24.04.

Step 1 — Installing Docker and Java

The Docker installation package available in the official Ubuntu repository may not be the latest version. To ensure we get the latest version, we’ll install Docker from the official Docker repository. To do that, we’ll add a new package source, add the GPG key from Docker to ensure the downloads are valid, and then install the package.

First, update your existing list of packages:

sudo apt update

Next, install a few prerequisite packages which let apt use packages over HTTPS:

sudo apt install apt-transport-https ca-certificates curl software-properties-common

Then add the GPG key for the official Docker repository to your system:

curl -fsSL https://download.docker.com/linux/ubuntu/gpg⁠ | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

Add the Docker repository to APT sources:

echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu⁠ $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

Update your existing list of packages again for the addition to be recognized:

sudo apt update

Make sure you are about to install from the Docker repo instead of the default Ubuntu repo:

apt-cache policy docker-ce

You’ll see output like this, although the version number for Docker may be different: Output of apt-cache policy docker-ce docker-ce: Installed: (none) Candidate: 5:20.10.143-0ubuntu-jammy Version table: 5:20.10.143-0ubuntu-jammy 500 500 https://download.docker.com/linux/ubuntu⁠ jammy/stable amd64 Packages 5:20.10.133-0ubuntu-jammy 500 500 https://download.docker.com/linux/ubuntu⁠ jammy/stable amd64 Packages Notice that docker-ce is not installed, but the candidate for installation is from the Docker repository for Ubuntu 24.04 (jammy).

Install Java:

sudo apt install default-jre

Finally, install Docker:

sudo apt install docker-ce

Docker should now be installed, the daemon started, and the process enabled to start on boot. Check that it’s running:

sudo systemctl status docker

The output should be similar to the following, showing that the service is active and running: Output docker.service - Docker Application Container Engine Loaded: loaded (/lib/systemd/system/docker.service; enabled; vendor preset: enabled) Active: active (running) since Fri 2022-04-01 21:30:25 UTC; 22s ago TriggeredBy: ● docker.socket Docs: https://docs.docker.com⁠ Main PID: 7854 (dockerd) Tasks: 7 Memory: 38.3M CPU: 340ms CGroup: /system.slice/docker.service └─7854 /usr/bin/dockerd -H fd:// --containerd=/run/containerd/containerd.sock

Step 2 — Preparing the Guardian Docker environment

The Guardian docker container requires a few parameters and environment settings. First, create a local folder where the data is stored persistently. This is important for the Guardian to work properly. You need at least 1TB of free storage on the host system for the Guardian. It is recommended that a data folder be created within the user’s home folder. However, you can also choose any other folder as long docker has the right to write in this folder. To create the persistent data folder, please follow the instructions below:

cd $home

mkdir guardian-storage

cd guardian-storage

mkdir data

Step 3 — Starting the Guardian docker container

sudo docker run --pull=always -d -p [EXTERNAL DB PORT]:[EXTERNAL DB PORT] -p [GUARDIAN PORT]:[GUARDIAN PORT] -v [PATH TO PERSISTANT STORAGE]:/var/solr -e SOLR_PORT=[EXTERNAL DB PORT] -e GUARDIAN_PORT= [GUARDIAN PORT] -e SOLR_HOST=[THE GUARDIAN EXTENRAL IP OR DOMAIN] -e GUID=[YOUR GUID] timpiltd/timpi-guardian

[EXTERNAL DB PORT] The external DB port can be anything. The default value is 8983

[GUARDIAN PORT] The Guardian port can be anything. The default value is 4005

[PATH TO PERSISTANT STORAGE] This is the path that you have created in step 2.

[THE GUARDIAN EXTERNAL IP OR DOMAIN] This MUST be the same IP/Domain you have used for the registration and the Guardian docker container MUST be accessible from external over this IP/Domain

[YOUR GUID] This MUST be the same GUID you have received when you registered the Guardian

Open ports

For your Guardian node to communicate with TAP [Timpi Autonomous Protocol] you'll need to open up 2 ports. These must be opened directly on your Linux system and any firewall/network layers you have in your setup.

The 2 default ports [at the time of writing] are:

8983

4005

If you choose different ports for your Guardian container configuration, you'll need to adjust the numbers accordingly.

To open ports on Ubuntu:

sudo ufw allow 8983/tcp

sudo ufw allow 4005/tcp