Keycloak#

Keycloak Open Source Identity and Access Management

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling keycloak#

Command:#

vlab set keycloak.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

keycloak
enable: True

Finalising changes:#

run: vlab update_one service=keycloak

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Tutorial on how to setup Keycloak for a Service

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=keycloak to complete the changes

ACCESS#

keycloak (HTTPS) link: https://keycloak.vivumlab.xyz/ keycloak (HTTP) link: http://keycloak.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set keycloak.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

keycloak
https_only: True
Finalising changes:#

run: vlab update_one service=keycloak

AUTH#

Default: False
Options: True/False

Command:#

vlab set keycloak.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

keycloak
auth: True
Finalising changes:#

run: vlab update_one service=keycloak

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set keycloak.domain keycloak.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

keycloak
domain: keycloak.com
Finalising changes:#

run: vlab update_one service=keycloak

SUBDOMAIN#

Default: keycloak
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set keycloak.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

keycloak
subdomain: media
Finalising changes:#

run: vlab update_one service=keycloak

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set keycloak.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

keycloak
version: 2.7
Finalising changes:#

run: vlab update_one service=keycloak

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.