docs/docs/examples/compose/keycloak

Deploy and Configure Keycloak for Docs

Installation

[!CAUTION] We provide those instructions as an example, for production environments, you should follow the official documentation.

Step 1: Prepare your working environment:

mkdir keycloak
curl -o keycloak/compose.yaml https://raw.githubusercontent.com/suitenumerique/docs/refs/heads/main/docs/examples/compose/keycloak/compose.yaml
curl -o keycloak/env.d/kc_postgresql https://raw.githubusercontent.com/suitenumerique/docs/refs/heads/main/env.d/production.dist/kc_postgresql
curl -o keycloak/env.d/keycloak https://raw.githubusercontent.com/suitenumerique/docs/refs/heads/main/env.d/production.dist/keycloak

Step 2:. Update env.d/ files

The following variables need to be updated with your own values, others can be left as is:

POSTGRES_PASSWORD=<generate postgres password>
KC_HOSTNAME=https://id.yourdomain.tld # Change with your own URL
KC_BOOTSTRAP_ADMIN_PASSWORD=<generate your password>

Step 3: Expose keycloak instance on https

[!NOTE] You can skip this section if you already have your own setup.

To access your Keycloak instance on the public network, it needs to be exposed on a domain with SSL termination. You can use our example with nginx proxy and Let's Encrypt companion for automated creation/renewal of certificates using acme.sh.

If following our example, uncomment the environment and network sections in compose file and update it with your values.

version: '3'
services:
  keycloak:
   ...
    # Uncomment and set your values if using our nginx proxy example
    # environment:
    # - VIRTUAL_HOST=id.yourdomain.tld # used by nginx proxy 
    # - VIRTUAL_PORT=8080 # used by nginx proxy
    # - LETSENCRYPT_HOST=id.yourdomain.tld # used by lets encrypt to generate TLS certificate
   ...
# Uncomment if using our nginx proxy example
#    networks:
#    - proxy-tier
#    - default

# Uncomment if using our nginx proxy example
#networks:
#  proxy-tier:
#    external: true

Step 4: Start the service

`docker compose up -d`

Your keycloak instance is now available on https://doc.yourdomain.tld

Creating an OIDC Client for Docs Application

Step 1: Create a New Realm

1. Log in to the Keycloak administration console.
2. Navigate to the realm tab and click on the "Create realm" button.
3. Enter the name of the realm - docs.
4. Click "Create".

Step 2: Create a New Client

1. Navigate to the "Clients" tab.
2. Click on the "Create client" button.
3. Enter the client ID - e.g. docs.
4. Enable "Client authentication" option.
5. Set the "Valid redirect URIs" to the URL of your docs application suffixed with /* - e.g., "https://docs.example.com/*".
6. Set the "Web Origins" to the URL of your docs application - e.g. https://docs.example.com.
7. Click "Save".

Step 3: Get Client Credentials

1. Go to the "Credentials" tab.
2. Copy the client ID (docs in this example) and the client secret.