Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 3.05 KB

README.md

File metadata and controls

84 lines (56 loc) · 3.05 KB
Raw

Container Image: RaBe Keycloak

Our Keycloak container image include the rabe-keycloak-theme and the included keycloak is augmented for our use-case.

The final image is based on the RaBe Universal Base Image 8 Minimal.

Usage

Use any standard Keycloak container deployment strategy to deploy ghcr.io/radiorabe/keycloak:lateset (but replace latest with a specific version).

Development

The development setup provides a docker-compose.yaml file to spin up a local instance for testing purposes.

The docker-compose.example.yaml contains some minimal settings for running locally can be used as an override as follows.

cp docker-compose.example.yaml docker-compose.override.yaml

# start database
podman-compose up -d db

# generate a keystore with a self-signed cert for local dev
keytool -genkeypair \
  -storepass password \
  -storetype PKCS12 \
  -keystore conf/server.keystore
  -alias server \
  -keyalg RSA \
  -keysize 2048 \
  -dname "CN=server" \
  -ext "SAN:c=DNS:localhost,IP:127.0.0.1" \

# build the container locally if you have changes you want to test
podman-compose build keycloak

# run keycloak in local terminal (and recreate it with each start to enasure the latest image is used)
podman-compose up keycloak --force-recreate

At this point you should be able to access keycloak via https://localhost:8443.

Release Management

The CI/CD setup uses semantic commit messages following the conventional commits standard. There is a GitHub Action in .github/workflows/semantic-release.yaml that uses go-semantic-commit to create new releases.

The commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

The commit contains the following structural elements, to communicate intent to the consumers of your library:

  1. fix: a commit of the type fix patches gets released with a PATCH version bump
  2. feat: a commit of the type feat gets released as a MINOR version bump
  3. BREAKING CHANGE: a commit that has a footer BREAKING CHANGE: gets released as a MAJOR version bump
  4. types other than fix: and feat: are allowed and don't trigger a release

If a commit does not contain a conventional commit style message you can fix it during the squash and merge operation on the PR.

Build Process

The CI/CD setup uses the Docker build-push Action to publish container images. This is managed in .github/workflows/release.yaml.

License

This application is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.

Copyright

Copyright (c) 2022 Radio Bern RaBe