EDDIE Framework

Appearance

Admin Console ​

The administrative console allows the eligible party to manage permission via a web interface. It will be served via <hostname>:<eddie.management.server.port>/outbound-connectors/admin-console. The default for eddie.management.server.port is 9090.

The admin console can be configured to require authentication. Currently, only basic auth and a single admin user is supported. The username for the admin user and a BCrypt encrypted password can be configured using properties or environment variables, as described below.

Configuration of the Admin Console ​

Configuration valuesDescription
outbound-connector.admin.console.enabledtrue or false, enables the admin console. Default is false
outbound-connector.admin.console.login.modebasic or keycloak, enables basic or keycloak authentication. Authentication is disabled by default.
outbound-connector.admin.console.login.usernameOnly required if basic login is enabled. Username for the admin user.
outbound-connector.admin.console.login.encoded-passwordOnly required if basic login is enabled. Password for the admin user encrypted using BCrypt.
outbound-connector.admin.console.login.keycloak.client-idOnly required if Keycloak login is enabled. ID of the Keycloak client.
outbound-connector.admin.console.login.keycloak.client-secretOnly required if Keycloak login is enabled. Client secret of the Keycloak client.
outbound-connector.admin.console.login.keycloak.issuer-uriOnly required if Keycloak login is enabled. Sets the issuer URL of the Keycloak server, for example http://localhost:8888/realms/EDDIE.

eddie.public.url and eddie.management.url are also required for the admin console to work as expected.

The region connector can be configured using Spring properties or environment variables. When using environment variables, the configuration values need to be converted in the following way:

  • Replace all non-alphanumeric characters with an underscore (_)
  • Optionally convert all letters to upper case

For basic authentication:

properties
outbound-connector.admin.console.enabled=true
outbound-connector.admin.console.login.mode=basic
outbound-connector.admin.console.login.username=admin
outbound-connector.admin.console.login.encoded-password=$2a$10$qYTmwhGa3dd7Sl1CdXKKHOfmf0lNXL3L2k4CVhhm3CfY131hrcEyS # encrypted value of 'password'
yaml
outbound-connector:
  admin:
    console:
      enabled: true
      login:
        mode: basic
        username: admin
        encoded-password: $2a$10$qYTmwhGa3dd7Sl1CdXKKHOfmf0lNXL3L2k4CVhhm3CfY131hrcEyS # encrypted value of 'password'
dotenv
OUTBOUND_CONNECTOR_ADMIN_CONSOLE_ENABLED=true
OUTBOUND_CONNECTOR_ADMIN_CONSOLE_LOGIN_MODE=basic
OUTBOUND_CONNECTOR_ADMIN_CONSOLE_LOGIN_USERNAME=admin
OUTBOUND_CONNECTOR_ADMIN_CONSOLE_LOGIN_ENCODED_PASSWORD=$2a$10$qYTmwhGa3dd7Sl1CdXKKHOfmf0lNXL3L2k4CVhhm3CfY131hrcEyS # encrypted value of 'password'

For Keycloak authentication:

properties
outbound-connector.admin.console.enabled=true
outbound-connector.admin.console.login.mode=keycloak
outbound-connector.admin.console.login.keycloak.client-id=eddie-client
outbound-connector.admin.console.login.keycloak.client-secret=client-secret
outbound-connector.admin.console.login.keycloak.issuer-uri=http://localhost:8888/realms/EDDIE
yaml
outbound-connector:
  admin:
    console:
      enabled: true
      login:
        mode: keycloak
        keycloak:
          client-id: eddie-client
          client-secret: client-secret
          issuer-uri: http://localhost:8888/realms/EDDIE
dotenv
OUTBOUND_CONNECTOR_ADMIN_CONSOLE_ENABLED=true
OUTBOUND_CONNECTOR_ADMIN_CONSOLE_LOGIN_MODE=keycloak
OUTBOUND_CONNECTOR_ADMIN_CONSOLE_LOGIN_KEYCLOAK_CLIENT_ID=eddie-client
OUTBOUND_CONNECTOR_ADMIN_CONSOLE_LOGIN_KEYCLOAK_CLIENT_SECRET=client-secret
OUTBOUND_CONNECTOR_ADMIN_CONSOLE_LOGIN_KEYCLOAK_ISSUER_URI=http://localhost:8888/realms/EDDIE