Skip to content

Latest commit

 

History

History
145 lines (110 loc) · 9.79 KB

README.md

File metadata and controls

145 lines (110 loc) · 9.79 KB
Raw

Aam Digital Setup

This repository describes how to set up everything that is needed to run the Aam Digital case management system in production. This includes deploying the app, deploying and connecting the database and optionally deploying and connecting the permission backend and keycloak.

The source code of the actual application, as well as instructions to run it on your local machine during development, can be found in the Aam-Digital/ndb-core repository.

(!) copy the example.* files (e.g. setup.example.env) and add your actual variables and config

Systems requirements

The deployment works with minimal requirements. All you need is a system that runs Docker and allows to reach endpoints through a public URL. For a single instance a server with 2GB RAM, a single CPU and 20GB disc space is sufficient. With more data and/or more deployments more RAM and CPU power might be necessary or the sync could start to become very slow. The required disc space scales with the amount of data and especially images and attachments that are saved in the application.

To monitor the hardware usage this repo contains a Prometheus setup. This can be connected with Grafana to create a system dashboard and trigger alerts on critical performance.

Deploying the application

The interactive script interactive_setup.sh walks you through the process of setting up new applications. Running the setup script will create a new folder in the same parent folder, next to the cloned repo. You can use the script multiple times to create new instances.

  1. Clone this repository
  2. Set up local environment by copying setup.example.env file and editing the setup.env and keyloak/.env
  3. Then run the script and follow the questions in the console to generate the required .env and other files:

    ./interactive_setup.sh

The following things can be automatically done

  1. Deploy the application
  2. (optional) add the permission backend
  3. (optional) connect with a running Keycloak
  4. (optional) migrate users from CouchDB to Keycloak

To log errors with Sentry, simply set the variable SENTRY_DSN in the .env file to you sentry DSN.

Adjusting the script

Some things have to be set for the interactive setup script through environment variables. Have a look at interactive_setup.sh to see which .env files are loaded there.

  1. Domain name for the final applications (variable domain)
  2. Prefix for created folders (variable prefix)
  3. the .env file of the keycloak deployment (see section User management in Keycloak)

Deploying under a domain name using nginx-proxy

In order to make the application's docker container accessible under a public URL, you need to expose it using a tool of your choice. The system works well with the nginx-proxy docker. This allows to automatically configure things so that the app is reachable under a specific domain name (including automatic setup of SSL certificates through letsencrypt).

This setup repository comes with a docker compose for setting up the nginx-proxy.

  1. Create the required network

    docker network create nginx-proxy_default

  2. In nginx-proxy/docker-compose.yml set DEFAULT_EMAIL to a valid email address
  3. Start the required containers (this is only needed once on a server)

    cd nginx-proxy && docker-compose up -d

  4. Set the VIRTUAL_HOSTandLETSENCRYPT_HOST as environment variables on new docker containers to define under which URL they should be reachable

User management in Keycloak

The system uses the Keycloak identity management system. All the required configuration can be found in the keycloak folder.

To start the required docker containers execute the following (this is only needed once on a server, you can skip these steps if you just want to add another Aam Digital instance to an existing keycloak server):

  1. Open the file keycloak/.env
  2. Set the password variables to secure passwords and assign valid urls for the Keycloak and account backend (without https://)
  3. Open keykloak/realm_config.json and add the required settings for you email server to enable Keycloak to send emails in your name
  4. Start the required containers

    cd keycloak && docker-compose up -d

Once done, applications can be connected with Keycloak through the interactive_setup.sh.

2-Factor-Auth

Keycloak supports a second login factor.

Authenticator app OTP

The only built-in second factor ist OTP using a Authenticator app. This can be enabled by editing a specific user in the Keycloak "Administration Console" and adding the Configure OTP in the "Required user actions". It can also be activated for everyone by changing the Browser - Conditional OTP in the used Browser flow from Conditional to Required.

Email OTP

Through 3rd party libraries OTP via Email is supported. This also comes with the option to trust the device for a configured time period (during which you do not have to enter the OTP when logging in).

To enable this feature visit <KEYCLOAK_URL>/admin/master/console/#/<REALM>/authentication/. If you created this realm using a recent version of the realm_config.json then you should find a flow with the name Email 2FA. Click on the 3 dot menu on the right of this flow and select Bind flow and select Browser flow. After saving, when trying to log in to the app you should be asked to enter the OTP which has been sent to the email that is associated with the username.

If you don't see the Email 2FA flow you have to configure it manually.

  1. Click on the 3 dot menu of the browser flow and select duplicate
  2. Enter Email 2FA as name
  3. Delete the last two steps (Condition - user configured and OTP form)
  4. Click on the + button in the last row (Email 2FA Browser - Conditional OTP)
  5. Select Add condition, there select Condition - Device Trusted and click Add
  6. On the new step (Condition - Device Trsuted) click on Disabled and change it to Required
  7. Click on the cog icon next to Required and enter trusted-config as Alias and click Save
  8. Again click on the + icon for Email 2FA Browser - Conditional OTP
  9. Select Add step, there select Email OTP and click Add
  10. Change Disabled to Required for Email OTP
  11. Again click on the + icon for Email 2FA Browser - Conditional OTP
  12. Select Add step, there select Register Trusted Device and click Add
  13. Change Disabled to Required for Register Trusted Device

Now the flow is configured correctly, and you can start using it the same way it has been described above.

In the step Email OTP you can configure the amount of seconds for which an OTP is valid and in the Register Trusted Device step you can configure how long a device will be trusted (e.g. P30d for 30 days or PT24h for 24 hours).

Further options

There are many ways in which the authentication flow can be configured. For example, you could also add the trust device step to the OTP with authenticator app, or you could make the user decide which OTP (email or app) should be used. Consult the Keycloak docs for ways to edit flows or configure new ones.

API Integrations and SQL Reports

It is possible to calculate reports for the app's data using SQL queries. For details information, check our Report documentation

Set up API Integration

(e.g. with TolaData)

  1. Enable the reporting backend:
    • add aam-backend-service to you COMPOSE_PROFILES .env variable to activate that container in the docker compose: COMPOSE_PROFILES=replication-backend,aam-backend-service
    • add AAM_BACKEND_SERVICE_URL=http://aam-backend-service:3000 to the .env file that feeds into the docker-compose.yml
    • add an application.env for the backend (config/aam-backend-service/application.env) --> see aam-services README
    • (re-up the docker compose and confirm the new containers are running)
  2. Create a "client" in Keycloak for login credentials:
    • Log into Keycloak and open the "Clients" section of the realm
    • Create a new client (type: OpenID Connect; Client authentication: On)
    • In the "Credentials" tab of the new client, copy the client secret
  3. For integration with TolaData:
    • In TolaData, navigate to Data Tables or User Profile and add Aam Digital credentials (customer_id: the realm / url prefix of the Aam Digital system; client id/secret: from Keycloak)
  4. Create ReportConfig: entities

Building the Docker Image

If you just want to use ndb-core through docker, you should not have to build the image yourself. Use the pre-built image on Docker Hub aamdigital/ndb-server.

The Dockerfile to build the image are part of the ndb-core repository. See the /build sub folder there.

The image builds upon a simple nginx webserver and modifies the configuration to include a reverse proxy for the domain.com/db URLs to access the CouchDB database from the same domain, avoiding CORS issues.