Deploy Lissi Agent using Docker-Compose

Prerequisites

Access to the Docker Images and Configuration Files

To setup Lissi Agent you require:

1. Access to the Docker images (is granted via a personal access token)

2. The Lissi Agent configuration files

Setup a VM

• Setup a VM preferably running Ubuntu 20.04 (LTS) with 2 CPUs and 4 GB RAM

• Allow HTTP and HTTPS connections on the ports 80 and 443

• Install docker: https://docs.docker.com/engine/install/ubuntu/

• Install docker-compose: https://docs.docker.com/compose/install/

• Login to the ACR through docker to have access to the Lissi Agent container images

  BASH

  sudo docker login -u [TOKEN_NAME] -p [TOKEN] milissi.azurecr.io 

Optional but recommended is to set the current user with privileged access to docker. Avoiding prefacing docker commands with sudo https://docs.docker.com/engine/install/linux-postinstall/

Register a Domain Name

Register a domain name that links to the VM’s public IP address. The UI, the controller and the user management system will respectively be accessible from this domain at https://YOUR.DOMAIN/, https://YOUR.DOMAIN/ctrl/ and https://YOUR.DOMAIN/auth.

Setup

1. Configuration Files

• Upload the configuration files to the server, unzip them, and store them into the folder ~/app

• Ensure that the manage.sh scripts in the folders keycloak, client, server are executable

  BASH

  sudo chmod 744 ~/app/keycloak/manage.sh
  sudo chmod 744 ~/app/server/manage.sh
  sudo chmod 744 ~/app/client/manage.sh

• Ensure that the ~/app/client/letsencrypt/renewCert.sh script is executable (chmod 744)

  BASH

  sudo chmod 744 ~/app/client/letsencrypt/renewCert.sh

2. .profile (Environment variables)

• Move the file .profile to ~/.profile

  BASH

  mv .profile ~/.profile

• Edit the values for the following variables - both will be used to create a Let's Encrypt Certificate

  • DOMAIN_NAME

  • EMAIL

• If desired the pre-filled KEYCLOAK_PASSWORD and AGENT_LABEL can be modified. The password will be necessary to connect to the user management system under https://YOUR.DOMAIN/auth. The label will be displayed on the Lissi Agent UI and in SSI Wallets when connecting to other agents.

• Source the .profile to apply the changes

  BASH

  source ~/.profile

3. Installation

• Run the script `install-lissi.sh`

  BASH

  cd ~/app
  ./install-lissi.sh

• Open the domain of your agent and log in using username lissi and password lissi

• On your first login, you are prompted to change the password to something secure