keycloak-standalone

Example:

# Install Keycloak standalone, incl. PostgreSQL server, Nginx and Let's Encrypt https certificate.
- keycloak-standalone:
    hostname: auth.example.com
    admin_email: hello@example.com
    keycloak_admin_password: password123

Description

Install a Keycloak standalone service.

This follows more or less the Keycloak documentation on how to install Keycloak in standalone mode.

It also installs Postgresql and the Nginx webserver, including https certificate (if so specified).

In case no 'keycloak_db_password' is specified, freckles will generate a random one.

Variables

Name Type Default Description

admin_email

n/a --

The email for letsencrypt. Required

hostname

string --

The (external) domain name, to be used by the reverse proxy. Required

keycloak_admin_password

string --

The initial admin user password. Required

keycloak_db_password

string --

The postgres database password. Required

keycloak_bind_ip

string 127.0.0.1

The ip address keycloak listens on.

keycloak_bind_ip_management

string --

The ip address the keycloak management interface listens on.

keycloak_db_name

string keycloak

The database name.

keycloak_db_user

string keycloak

The database user.

letsencrypt_staging

boolean False

Whether to use the letsencrypt staging server (for development).

version

string 6.0.1

The version of keycloak.

Examples

Example 1

Install Keycloak standalone, incl. PostgreSQL server, Nginx and Let's Encrypt https certificate.

Code
- keycloak-standalone:
    hostname: auth.example.com
    admin_email: hello@example.com
    keycloak_admin_password: password123

Command-line

frecklecute --community keycloak-standalone --help

Usage: frecklecute keycloak-standalone [OPTIONS]

  Install a Keycloak standalone service.

  This follows more or less the [Keycloak
  documentation](https://www.keycloak.org/docs/latest/getting_started/) on
  how to install Keycloak in standalone mode.

  It also installs Postgresql and the Nginx webserver, including https
  certificate (if so specified).

  In case no 'keycloak_db_password' is specified, freckles will generate a
  random one.

Options:
  --admin-email ADMIN_EMAIL       The email for letsencrypt.  [required]
  --hostname HOSTNAME             The (external) domain name, to be used by
                                  the reverse proxy.  [required]
  --keycloak-admin-password KEYCLOAK_ADMIN_PASSWORD
                                  The initial admin user password.  [required]
  --keycloak-db-password KEYCLOAK_DB_PASSWORD
                                  The postgres database password.  [required]
  --keycloak-bind-ip IP           The ip address keycloak listens on.
  --keycloak-bind-ip-management IP
                                  The ip address the keycloak management
                                  interface listens on.
  --keycloak-db-name KEYCLOAK_DB_NAME
                                  The database name.
  --keycloak-db-user KEYCLOAK_DB_USER
                                  The database user.
  --letsencrypt-staging           Whether to use the letsencrypt staging
                                  server (for development).
  --version VERSION               The version of keycloak.
  --help                          Show this message and exit.