How to Install ZITADEL on Linux Mint

ZITADEL is an open source IAM (Identity and Access Management) solution that allows organizations to securely manage the identity of their users and the permissions they have to access resources. In this tutorial, we will guide you through the process of installing ZITADEL on Linux Mint.

Prerequisites

  • A Linux Mint computer with root or sudo privileges
  • Docker and docker-compose installed

Installation Steps

  1. Open a command terminal on Linux Mint by pressing Ctrl + Alt + T or by searching for "Terminal" in the applications menu.

  2. Install git if it is not already installed on your system:

sudo apt update
sudo apt install git
  1. Clone the ZITADEL repository from GitHub:
git clone https://github.com/caos/zitadel.git
  1. Change the directory to the cloned repository:
cd zitadel
  1. Checkout the latest tagged release:
git tag
git checkout tags/<latest-release>

Replace <latest-release> with the latest tag available.

  1. Copy the sample .env file and set the required environment variables:
cp .env.example .env
nano .env

The .env file contains the configuration for the ZITADEL Docker containers. The following environment variables are required:

  • ZITADEL_DOMAIN: The domain to use for the ZITADEL service.
  • ZITADEL_HTTP_PORT: The port to use for HTTP traffic.
  • ZITADEL_HTTPS_PORT: The port to use for HTTPS traffic.
  • ZITADEL_ROOT_DOMAIN: The root domain for the ZITADEL service.
  • ZITADEL_ROOT_DOMAIN_ALIAS: The root domain alias for the ZITADEL service.

You can use the default values in the .env file or modify them according to your requirements.

  1. Start the ZITADEL Docker containers:
docker-compose up -d

This command will download and start the required Docker containers for ZITADEL.

  1. Verify that the ZITADEL containers are running:
docker ps

You should see the following containers running:

  • caos/zitadel-cm: The configuration management container.
  • caos/zitadel-iam: The identity and access management container.

Congratulations! You have successfully installed ZITADEL on Linux Mint. You can now access the ZITADEL web interface by going to http://<ZITADEL_DOMAIN>:<ZITADEL_HTTP_PORT> in your web browser.