Setting up a demo configuration

Welcome to the Lucenia Security demo configuration setup guide. This tool provides a quick and easy way to replicate a production environment for testing purposes. The demo configuration includes the setup of security-related components, such as internal users, roles, role mappings, audit configuration, basic authentication, tenants, and allow lists.

The demo configuration tool performs the following tasks:

1. Configures security settings, which are then loaded into the security index.
2. Generates demo certificates.
3. Adds security-related settings to the lucenia.yml file.

Installing the demo configuration

The demo configuration is automatically called as part of the setup for each supported distribution of Lucenia. The following are instructions for each distribution.

Note: A custom admin password is required in order to install the demo configuration. If none is provided, the cluster will fail to start. Note that this change only affects new clusters. Existing clusters are not affected because they already have lucenia.yml configured, so the installation tool will not run.

Docker

Use the following steps to set up the Security plugin using Docker:

1. Download docker-compose.yml.
2. Run the following command:

docker-compose up

Setting up a custom admin password

Note: You must set the initial admin password before installation. To customize the admin password, you can take the following steps:

1. Download the following sample docker-compose.yml file.
2. Create a .env file.

3. Add the variable LUCENIA_INITIAL_ADMIN_PASSWORD and set the variable with a strong password. The password must pass the following complexity requirements:

   • Minimum 8 characters
   • Must contain at least one uppercase letter [A–Z]
   • One lowercase letter [a–z]
   • One digit [0–9]
   • One special character
4. Run docker-compose up.

TAR (Linux)

For TAR distributions on Linux, download the Linux setup files from the Lucenia Download & Get Started page. Then use the following command to run the demo configuration:

./lucenia-tar-install.sh

Set a new custom admin password before installation by using the following command:

export LUCENIA_INITIAL_ADMIN_PASSWORD=<custom-admin-password>

Windows

For ZIP distributions on Windows, after downloading and extracting the setup files, run the following command:

> .\lucenia-windows-install.bat

Set a new custom admin password before installation by running the following command:

> set LUCENIA_INITIAL_ADMIN_PASSWORD=<custom-admin-password>

Helm

For Helm charts, the demo configuration is automatically installed during the Lucenia installation. Customize the admin password in values.yaml under extraEnvs:

extraEnvs:
  - name: LUCENIA_INITIAL_ADMIN_PASSWORD
    value: <custom-admin-password>

RPM

For RPM packages, install Lucenia and set up the demo configuration by running the following command:

sudo yum install lucenia-0.1.0-linux-x64.rpm

Set a new custom admin password before installation by using the following command:

sudo env LUCENIA_INITIAL_ADMIN_PASSWORD=<custom-admin-password> yum install lucenia-0.1.0-linux-x64.rpm

DEB

For DEB packages, install Lucenia and set up the demo configuration by running the following command:

sudo dpkg -i lucenia-0.1.0-linux-arm64.deb

Set a new custom admin password before installation by using the following command:

sudo env LUCENIA_INITIAL_ADMIN_PASSWORD=<custom-admin-password> dpkg -i lucenia-0.1.0-linux-arm64.deb