Full installation of Soffid 4 as dev/test environment (for Soffid users)

Introduction

This guide is only for Soffid users.

This guide describes all the steps required to install Soffid 4 as dev/test environment.

The simplest installation is using Docker Compose.

Prerequisites

User prerequisites:

• We have a Linux machine; Ubuntu 24 has been used for this tutorial.
• The Linux administrator user has sudo privileges.
  
• To have a Soffid user.

Soffid prerequisites:

• Your Soffid user has to had a special role to download Soffid 4 images.
• Your Soffid user has to has a Soffid 4 license.

Docker & Docker compose

The first step is to install Docker and Docker compose. Docker is the platform and compose is a tool that simplifies management.

Follow the steps at the following link to install Docker and Docker Compose: 

• Step 1. Install Docker: https://bookstack.soffid.com/books/soffid-internal-documentation/page/how-to-install-docker
• Step 2. Install Docker Compose: https://bookstack.soffid.com/books/soffid-internal-documentation/page/how-to-install-docker-compose
• Step 3. Use docker without sudo : https://bookstack.soffid.com/books/soffid-internal-documentation/page/docker-compose-commands#bkmrk-use-docker-without-s

Soffid 4 docker registry

Soffid 4 has transitioned from Docker Hub to Google Cloud Artifact Registry for image distribution. To successfully download Soffid 4 images, you must complete the following configuration steps.

Step 1: Install and configure gcloud cli

• Follow this tutorial: https://cloud.google.com/sdk/docs/install?hl=es-419#deb
• In the "gcloud init" use or select your Soffid account
• Then select the project: soffid-docker-images

Step 2: register the domain

• gcloud auth configure-docker europe-docker.pkg.dev
  

Step 3: test the configuration pulling an image (¡Do not use sudo with docker, it does not work!).

• docker pull "europe-docker.pkg.dev/soffid-docker-images/private/iam-console:4.0.0"

Install Soffid 4

The fastest way to generate a local environment is with Docker Compose.

At this link, you can see the most commonly used Docker Compose commands: Docker compose commands

Follow the instructions at the following link:

• https://bookstack.soffid.com/books/installation/page/installing-soffid

We have to wait until the login page will be prompted.

• http://localhost:8080
• Aceptar el bótin de Actualización
• User: admin / password: changeit (temporal)
• Indicar el nuevo password final

Configure SSL access

To correctly validate the new license, the Soffid Console must be SSL-enabled, it has to be open with the https protocol.

If you have a local environment, create new entries in /etc/hosts (Linux) or C:\Windows\System32\drivers\etc (Windows).

# Soffid 4 local
127.0.0.1 console.soffid4.local
127.0.0.1 syncserver.soffid4.local

Generate a self-signed certificate (pfx).

• https://bookstack.soffid.com/books/soffid-internal-documentation/page/how-to-create-an-self-signed-certificate-with-openssl

Use 12345678 for all requiered passwords.

sudo openssl genrsa -aes256 -out console.soffid4.local.key
sudo openssl req -x509 -days 1000 -new -key console.soffid4.local.key -out console.soffid4.local.pem
sudo openssl pkcs12 -export -in console.soffid4.local.pem -inkey console.soffid4.local.key -out console.soffid4.local.pfx

Copy this certificate in the console container.

sudo docker compose cp console.soffid4.local.pfx console:/opt/soffid/iam-console-4/trustedcerts

Enter the container, generate the jks file and configure it in the server.xml.

• https://bookstack.soffid.com/books/installation/page/configure-tls-for-iam-console-153

Publish the new port in docker compose and regenerate.

  consoleversion4:
...
    ports: 
      - "8088:8080"
      - "8443:8443"

Update the system:

docker compose up -d

Connect to the new URL:

• https://console.soffid4.local:8443

Apply the license

When accessing the Soffid Console for the first time, you will need to apply a licence that the Soffid team will have created for you beforehand. Check this link:

• https://bookstack.soffid.com/books/soffid-4-reference-guide/page/license-and-plugin#bkmrk-first-access-to-soff

To apply the license follow these steps:

• Log into the Soffid Console
• Go to the "License and plugin" page
• You will not have an active license
• Click the "Manage license" button
• Log in with your new Soffid account received from Soffid
• Select your new license
• Accept the conditions

Finally you will have an active license and access to all pages