luechtdiode/kutuapp repository overview

Simple docker-image to deploy kutuapp-server in container-based environment.

Without any configuration, the image expects a writable disk (a docker-volume with rw-permissions) at /home/kutuapp mount-point.

With configuration, it's possible to connect to a database. There's one default-configuration, which can be activated by the following ENV-Parameters:

• X_DB_CONFIG_NAME points to the config-name to be found in the default-config /kutuapp/kutuapp.conf. In the default-config exists a postgres-defined config named kutudb_pg. So with ENV X_DB_CONFIG_NAME kutudb_pg, that config will be used.

If the file /kutuapp/kutuapp.confis not replaced by an additional docker-image layer, with this file are further the follwing ENV-Parameters provided:

• X_POSTGRES_HOST Points to the Host and Port of the connection-url. Be aware, that the expected Database-name is kutuapp and there should be a schema named `kutu'.
• X_POSTGRES_USER Username for the Connetion, with full permission-set (should be able to modify the tables and indicies of the kutu-schema)
• X_POSTGRES_PASSWORD The passwort for the given Username.

If the file /kutuapp/kutuapp.confis replaced by an additional docker-image layer, the name of the connection-setting (see X_DB_CONFIG_NAME) can be named as desired but should follow the scala-slick 3.1 connection-config specification (see https://scala-slick.org/doc/3.1.0/database.html⁠). If other drivers are used than HikariCP, Postgres or SQLite, the required jar-files should also be appended to the classpath, defined in the ENTRYPOINT's start-command.

If you want to be able to send EMails (e.g. for Password-Reset), then assign the following ENV-Parameters:

• X_SMTP_HOST
• X_SMTP_PORT
• X_SMTP_USERNAME
• X_SMTP_DOMAIN
• X_SMTP_PASSWORD

Further details can be found at https://github.com/luechtdiode/KuTu⁠