Page Comparison

Our installation bundle for the comment server consists of several files:

.env

In this file, environment variables are set that define under which SSL port the application should run. It also defines the names of the files that contain the SSL certificate and SSL key you have provided for your domain.

*_password.txt

Two files ending with "_password.txt" define which passwords (initial) are to be used for the database and the global administrator user.

config.properties

This is where the settings for our comment server are defined. Currently it is used to configure the SMTP mail server used to send notification emails when a user is mentioned in a comment.

init-commenting-db.sql

The initialisation of the Postgres server with a new database and two schemas is defined here. Nothing is to be adjusted here by the user.

nginx.conf

The configuration file contains the definition of how the NGINX reverse proxy should forward the requests against the commenting backend to the individual Docker containers. Usually nothing needs to be adjusted by the user here.

docker-compose.yaml

The definition of which containers must be created for the commenting backend, which files may be used by the host system and how the internal network is structured does not usually need to be adapted.

commenting.war

This file contains the logic for the commenting backend and is automatically installed in the Tomcat container in Docker.

Installation process

1. Install Docker as described here: https://docs.docker.com/engine/install/

2. Unpack the installation bundle and copy the files from the installation bundle to the Docker host system in any location.

3. You insert your SSL certificate with the file name "ssl_certificate.crt" and the corresponding private key with the file name "ssl_certificate.pem" in the same location as in step 1. If the paths or file names are different, the ".env" file must be adapted.

4. If you want to use a port other than "3333" for the server, adjust the port in the ".env" file.

5. In the "commenting_db_password.txt" file you define the passwords password for the user administration database and the comment repository. This is transmitted internally to the corresponding containers.

6. In der Datei “keycloakthe file "keycloak_admin_password.txt” definieren Sie das Passwort für den Administrator des Kommentarbackends. Dieser besitzt die Berechtigung Kommentare zu lesen, zu schreiben, zu bearbeiten, zu löschen und neue Benutzer zu definieren. Sie benötigen dessen Passwort also um sich initial in unsere Komponenten und die Verwaltungsoberfläche einzuloggen. Der Benutzername lautet hier “admin”. Neu angelegten Benutzern können dann die Rollen “viewer”, “editor” oder “admin” zugewiesen werden.Ist die Konfiguration vollständig, so können Sie in der Kommandozeile in dem Ordner des Installationsbundles den Befehl “docker-compose up” ausführen. Damit werden alle benötigten Komponenten gestartettxt" you set password for the comment backend administrator. The administrator is authorised to read, write, edit and delete comments and to create new users. You will need this password to log in to our components and the admin interface for the first time. The username here is "admin". Newly created users can then be assigned the roles "viewer", "editor" or "admin".

7. When the configuration is complete, you can run "docker-compose up" from the command line in the installation bundle folder. This will launch all the required components.

8. After the first start, the client secret must be read from the Keycloak UI under <server URL>/auth for the "frontend" client. This should then be inserted into the "keycloak_client_secret.txt". A subsequent restart via "docker compose stop" and "docker compose up" is necessary.

Once you have successfully installed the service, there are three things you can do to check that it is working:

• At the root URL to the service, a JSON should appear with information about the service and the installed version.

• <Server URL>/auth should open the user interface of Keycloak, where you can log in with the initial admin user data by clicking on "Administration Console". Here you can also connect other ident providers to our service. For example, Active Directory via SAML and external OAuth providers. For more information, please consult the Keycloak documentation.

• Finally, please check whether our user interface for the backend appears under <server URL>/commenting/administration/. Here you can, with a valid user (e.g. the admin again), view existing comments, edit them and also create new ones. You have the option of creating new users and authorising them to use context combinations.