Wicket Participate

At the end of 2016 I have heard of the Apache Wicket Framework and started to write a closed-source (now open-source) web application for one of my project choirs Kammerchor Wernigerode. We had trouble to plan our weekends because some singers did not answer to invitations of the board members.

Setup

Copy or move the sample files in the rest and configure your properties.

cp src/main/resources/application.sample.properties src/main/resources/application.properties

cp src/main/resources/liquibase.sample.properties src/main/resources/liquibase.properties

Install the maven dependencies.

mvn install

You'll need a MySQL database or a running Docker Container with MySQL. Start the application with

mvn spring-boot:run

Docker

Start a container with

docker run \
 --env APPLICATION_NAME='Application Name' \
 --env APPLICATION_CUSTOMER='Application Customer' \
 --env APPLICATION_PASSWORD='application_password' \
 --env DATABASE_HOST='mysql' \
 --env DATABASE_PORT=3306 \
 --env DATABASE_NAME='participate' \
 --env DATABASE_USER='participate' \
 --env DATABASE_PASSWORD='participate' \
 --env SMTP_HOST='mail.domain.tld' \
 --env SMTP_PORT=587 \
 --env SMTP_USER='mail.user@domain.tld' \
 --env SMTP_PASSWORD='mail_password' \
 --env MAIL_FROM='mail.user@domain.tld' \
 --env MAIL_REPLY_TO='no-reply@domain.tld' \
 --env BASE_URL='http://localhost:8080' \
 --env LOG_PATH=/tmp \
 -p 8080:8080 \
 --name participate \
 --link participate-db:mysql \
 kchwr/participate

make sure you are running a database container too.

The Docker example does not cover proprietary features. Check the Feature class for more information.

---

Run the command below to start a development database as well as FakeSMTP. Received emails will be stored in $HOME/received-emails.

docker compose up -d

Deployment

mvn clean package

creates an executable jar file. Start the application with

java -jar target/participate-4.5.0-SNAPSHOT.jar

on your machine. Don't forget to configure the properties files to fit your environment or follow the Docker instructions above to deploy the application with Docker.

Features

Lately, two features have been added, which can be turned on and off by means of enabled-flag in the application.yml file.

Remind overdue singers

If the feature is active, all participants who have not yet registered for the next event will receive another invitation by email. By default, all events are considered that are up to 14 days in the future.

The cron expression and the offset are configurable. However, the email address of the manager must be configured.

Score's manager notification

Before the start of the next event, the score's manager will receive an email with a list of attending members. By default, all events are considered that are up to 7 days in the future.

The cron expression and the offset are configurable.

Keycloak

Keycloak is an authorization provider that implements the OAuth2 and OpenID Connect protocols. It manages software clients, users, their roles and claims for the project.

Authorization via OpenID Connect is deactivated by default. Add keycloak to the list of active Spring profiles to enable this feature.

Users

Keycloak is preconfigured with a variety of users that are more or less useful. The username-password-combination admin:secret might be the only one you ever need for development and manual testing.

Username	Password	Description	Realm	URL
admin	secret	Realm and application administrator	local	http://localhost:8180/admin/local/console/
vnl	secret	Management staff	local	http://localhost:8180/admin/local/console/
superadmin1	secret1	Keycloak administrator	master	http://localhost:8180/admin/master/console/

Configuration Export

This section explains how to export updated configurations so that they can be managed by Git. The development configuration for Keycloak is part of this project to distribute changes through Git.

First, make sure your development stack is up and running. Perform your necessary changes in the Keycloak web UI. Next, perform the following command. This will start a new Keycloak instance inside the running container.

docker compose -f docker-compose.yml -f docker-compose.keycloak.yml exec keycloak \
  /opt/keycloak/bin/kc.sh export --dir /opt/keycloak/data/import --realm local --users realm_file

Licence

Apache License 2.0 - Vinado - Built with ❤️ in Dresden

Footnotes

1. Corresponds to the values of KEYCLOAK_ADMIN and KEYCLOAK_ADMIN_PASSWORD, set for Composes' keycloak. ↩ ↩²