DataMasque Portal

Docker Installation

This page guides you through installing Docker, Docker Compose, and DataMasque on a supported Ubuntu or Red Hat Enterprise Linux (RHEL) system.

Refer to Linux Server Installation for system and OS version requirements.

Docker Setup for Ubuntu

To install Docker on Ubuntu machines, follow the Ubuntu installation instructions.

On Ubuntu, the docker service will automatically start after installation and on subsequent reboots.

You should ensure the user account that will be performing the DataMasque installation and administrative actions is added to the docker group. If you do not complete this step, all docker commands will require elevation to root privileges via sudo.

Docker setup for RHEL

To install Docker on RHEL machines, follow the RHEL installation instructions.

  • Docker should be installed from packages, not a convenience script.
  • You should ensure the user account that will be performing the DataMasque installation and administrative actions is added to the docker group. If you do not complete this step, all docker and docker compose commands will require elevation to root privileges via sudo.

Once Docker is installed, you need to start the docker service manually using the appropriate systemctl command:

sudo systemctl start docker

Alternatively, refer to Configure Docker to start on boot to configure the docker service to start up on boot.

You should ensure the user account that will be performing the DataMasque installation and administrative actions is added to the dockergroup. If you do not complete this step, all docker and docker compose commands will require elevation to root privileges via sudo.

Docker setup for Amazon Linux

The following instructions show how to install Docker on Amazon Linux 2023 machines. Note that Amazon Linux requires Docker Compose to be installed from the Docker GitHub, it is not available through yum.

  1. SSH to the EC2 instance.

  2. Update the package cache with yum:

$ sudo yum update -y
  1. Install Docker with yum:
$ sudo yum install -y docker
  1. Install Docker Compose from the official Docker GitHub.
$ sudo mkdir -p /usr/local/lib/docker/cli-plugins/
$ sudo curl -SL https://github.com/docker/compose/releases/download/v2.29.4/docker-compose-linux-x86_64  -o /usr/local/lib/docker/cli-plugins/docker-compose
$ sudo chmod 755 /usr/local/lib/docker/cli-plugins/docker-compose
  1. Start the Docker service:
$ sudo service docker start
  1. Add the ec2-user to the docker group so that you can run Docker commands without using sudo:
$ sudo usermod -a -G docker ec2-user

If you do not complete this step, all docker and docker compose commands will require elevation to root privileges via sudo.

Install DataMasque

Extract the provided DataMasque Docker Compose package on the server, and run the included installation script:

tar -xvzf datamasque-docker-v<version>.pkg
cd datamasque/<version>/
sudo ./install.sh

During installation, a new datamasque user and group will be created and assigned ownership of the DataMasque configuration files under /usr/local/etc/datamasque/. You can manually select the uid and gid for the datamasque user and group by providing --uid and --gid options to install.sh:

sudo ./install.sh --uid 1010 --gid 1010

Once the installation script has run, you can confirm the DataMasque Docker containers are running with the following command:

docker ps --format "table {{.ID}}\t{{.Status}}\t{{.Names}}"

If installation was successful, you should see five DataMasque containers listed:

CONTAINER ID        STATUS              NAMES
60114d0c370d        Up 3 minutes        datamasque_admin-frontend_1
da8bacfbbe48        Up 3 minutes        datamasque_admin-server_1
c9555bf98017        Up 3 minutes        datamasque_agent-worker_1
d46296fd5b3b        Up 3 minutes        datamasque_agent-queue_1
1d5516575e1c        Up 3 minutes        datamasque_admin-db_1

You can now access your DataMasque instance from a client web browser at https://<instance-ip-or-hostname>. Follow the Initial Setup guide to complete the installation of DataMasque.

Note: The first time you visit DataMasque, your browser will display a security warning because the self-signed certificate generated by DataMasque will be untrusted by your browser. You may proceed past this warning for now, and install your own trusted certificate after installation is complete (refer to Installing SSL Credentials). If you are unable to proceed past the warning due to HSTS being enabled for your domain, refer to Installation with HSTS enabled.