Skip to main content

Setup

Requirements​

Before setting up enterprise-knowledge-platform application, following packages need to be installed:​

  1. Docker(version 25.0.3).
  2. Docker compose(version 1.29.2).
  3. JDK 17.

Setup​

For running the application we need to start docker-compose.yml file where Postgres SQL and Keycloak services are defined. Perform steps described below to be able to run application and make request to it.

  1. Create folders for volumes devices with paths same as in docker-compose.yml file.
  2. Run docker-compose start.
  3. Open the Keycloak in the browser on the localhost.(Port is written in projects application.yml)
  4. Select the application realm.(Top left select box)
  5. In the Users tab create user.
  6. Go to the Credentials tab and press Reset password.
  7. Set any password for your user, turn off the Tepmorary flag and press Save.
  8. Start the application.(During the start all available roles are saved in your local Keycloak db).
  9. Go to the Role mapping tab for the selected user and assign needed roles to the user.(For each endpoint besides login endpoint there is a specific role)

After performing steps above, you'll be able to sign in with the user described in steps 6 and 7, and make requests to the endpoints to which your user has roles.