Install Outline and Keycloak Using Docker Compose
This article is intended for those who were looking for a detailed and understandable guide on how to install Outline and Keycloak using Docker Compose.
Outline is a free standalone wiki engine and a collaborative knowledge base for teams.
💾 You can find the repository used in this guide on GitHub.
In this guide, Outline will use user accounts created in Keycloak for access to the Outline management panel, and MinIO for storing documents uploaded through Outline.
We will be using Traefik as a reverse proxy. It will be responsible for obtaining cryptographic certificates for your domain names from Let’s Encrypt and redirecting requests to specific domain names to the services corresponding to those domain names.
❗ It is important to note that you will need cryptographic certificates for your domain names. In my configuration, certificates are requested automatically using Traefik and Let’s Encrypt. Remember that without a secure connection, the services will not work.
❗ To obtain cryptographic certificates, you will need A-type records in the external DNS zone, which point to the IP address of your server where Traefik is installed. If you have created these records recently, you should wait before starting the installation of the services. Full replication of these records between DNS servers can take from a few minutes to 48 hours or even longer in rare cases.
In this guide, we will consider the case where you already have a server with Ubuntu Server 22.04 LTS installed on it.
You can find detailed information on how to install Ubuntu Server 22.04 LTS in my guide “Install Ubuntu Server 22.04 LTS”.
Docker Engine and Docker Compose must also be installed on the server.
You can learn how to install Docker Engine on Ubuntu Server by reading Install Docker Engine and Docker Compose on Ubuntu Server”.
In addition, OpenSSH must be installed on the server, and port 22 must be open in order to be able to connect to the server using the SSH protocol.
To install OpenSSH on the server you can use the command:
sudo apt install openssh-serverIf you plan to connect to the server using the Windows operating system, you can use PuTTY or MobaXterm.
This guide covers connecting to the server using the terminal emulator iTerm2, installed on the macOS operating system.
💡 Please note, you will need to open the following TCP ports for access to the services:
- TCP port 80 - to obtain a free cryptographic certificate through the Let’s Encrypt certification center.
- TCP port 443 - to access the Outline web interface.
We connect to the server on which Outline is planned to be installed.
Now it is necessary to create networks for your services.
We create a network for Traefik using the command:
docker network create traefik-network
We create a network for Keycloak using the command:
docker network create keycloak-network
We create a network for Outline using the command:
docker network create outline-network
Next, you need to clone the repository that contains the configuration files, which include all the necessary conditions for Outline to work.
You can clone the repository using the command:
git clone https://github.com/heyValdemar/outline-keycloak-traefik-letsencrypt-docker-compose.git
Navigate to the directory with the repository using the command:
cd outline-keycloak-traefik-letsencrypt-docker-compose
Next, you need to change the variables in the .env file according to your requirements.
💡 Note that the .env file should be in the same directory as 01-traefik-outline-letsencrypt-docker-compose.yml, 02-keycloak-outline-docker-compose.yml, and 03-outline-minio-redis-docker-compose.yml.
❗ The value for the OUTLINE_OIDC_CLIENT_SECRET variable can be obtained after installing Keycloak using 02-keycloak-outline-docker-compose.yml.
❗ Additionally, you need to specify your values for OUTLINE_SECRET_KEY and OUTLINE_UTILS_SECRET.
The values for OUTLINE_SECRET_KEY and OUTLINE_UTILS_SECRET can be generated using the command:
openssl rand -hex 32Now we will start Traefik using the command:
docker compose -f 01-traefik-outline-letsencrypt-docker-compose.yml -p traefik up -d
Next, we will start Keycloak using the command:
docker compose -f 02-keycloak-outline-docker-compose.yml -p keycloak up -d
From the workstation, navigate to the link https://keycloak.outline.heyvaldemar.net, where keycloak.outline.heyvaldemar.net is the name of my subdomain for accessing the Keycloak management panel. Accordingly, you need to specify your domain name, which points to the IP address of your server with the installed Traefik service, which will redirect the request to Keycloak.
Click on the “Administration Console” button.
Enter the username and password that you previously set in the .env file, and click the “Sign In” button.
Now you need to create a new Realm and configure it correctly so that users can log into Outline using Keycloak.
Click the “Create Realm” button in the upper left corner.
In the “Realm name” field, enter “outline” (in lowercase) and click the “Create” button.
Next, select “Clients” in the “Manage” section and click the “Create client” button.
In the “Client type” field, select “OpenID Connect”.
In the “Client ID” field, enter “outline” (in lowercase) and click the “Next” button.
Next, you need to enable “Client authentication” and select “Standard flow” in the “Authentication flow” section.
All other values should be disabled.
Click the “Next” button.
In the “Root URL” field, enter https://outline.heyvaldemar.net/
In the “Home URL” field, enter https://outline.heyvaldemar.net/
In the “Valid redirect URIs” field, enter https://outline.heyvaldemar.net/*
💡 Please note, outline.heyvaldemar.net is the domain name of my service. Accordingly, you need to specify your domain name, which points to the IP address of your server with the installed Traefik service, which will redirect the request to Outline.
Click the “Save” button.
Navigate to the “Credentials” tab and copy the contents of the “Client secret” field.
Paste the copied contents of the “Client secret” field into the OUTLINE_OIDC_CLIENT_SECRET variable in the .env file.
Now let’s create a user who will be able to log into Outline using Keycloak.
Select “Users” in the “Manage” section and click the “Add user” button.
In the next step, you need to specify: username, email address, first name, last name, and password.
💡 Note that if you provide an email address, the user will be able to log into Outline using not only the username but also the email.
Click the “Create” button.
Next, you need to set a password for the new user.
Go to the “Credentials” tab and click the “Set password” button.
Enter a strong password and click the “Save” button.
Certainly! Below is the translation of the provided text:
Click the “Save password” button to confirm the assignment of a new password for the user.
The new password has been successfully set.
Now you can launch Outline with accompanying services and log into Outline using the previously created user.
Let’s launch Outline with the following command:
docker compose -f 03-outline-minio-redis-docker-compose.yml -p outline up -d
To access the Outline management panel, go to https://outline.heyvaldemar.net from your workstation, where outline.heyvaldemar.net is the domain name of my service. Accordingly, you need to specify your domain name that points to the IP address of your server with the installed Traefik service, which will redirect the request to Outline.
💡 Note that you need to specify the domain name of the service, previously defined in the .env file.
Click the “Continue with Keycloak” button.
Enter the username or email address and password previously set in Keycloak.
Welcome to the Outline control panel.
To access the MinIO control panel, go to https://console.minio.outline.heyvaldemar.net from your workstation, where console.minio.outline.heyvaldemar.net is the domain name of my service. Accordingly, you need to specify your domain name that points to the IP address of your server with the installed Traefik service, which will redirect the request to MinIO.
💡 Note that you need to specify the domain name of the service, previously defined in the .env file.
Enter the username and password previously set in the .env file, and click the “Login” button.
To access the Traefik control panel, go to https://traefik.outline.heyvaldemar.net from your workstation, where traefik.outline.heyvaldemar.net is the domain name of my service. Accordingly, you need to specify your domain name that points to the IP address of your server with the installed Traefik.
💡 Note that you need to specify the domain name of the service, previously defined in the .env file.
Enter the username and password previously set in the .env file, and click the “OK” button.
Welcome to the Traefik control panel.
