Optional features

Optional Features

All configuration options in this file are given in the form this.is.a.property. To configure those using environment variables, e.g. in docker-compose.yml those options have to be converted to uppercase: THIS_IS_A_PROPERTY.

Mail notifications

To enable mail notifications a mail server (e.g. postfix) is needed.

spring.mail.host=localhost
spring.mail.port=25
spring.mail.username=[[mail_user]]
spring.mail.password=[[mail_password]]

When this configuration is present, users can opt in to mail notifications using the UI.

API access

Users can be granted access to the acrarium API, which provides RESTful read-only access to its data. Available methods can be found here.

Health-check and other production-ready features

Acrarium bundles Spring Boot Actuator. All endpoints are disabled by default.

You can enable the ones you need, e.g.

management.endpoint.health.enabled=true

Advanced configuration

Acrarium is built with Spring Boot, so most Spring Boot configuration options work as well. Some examples:

# This is necessary in multiple situations, e.g. to make links in mails work.
server.context-path=https://example.com:8080

# Enable ssl
server.ssl.enabled=true
server.ssl.key-store=[[path]]
server.ssl.key-store-password=[[passsword]]
server.ssl.key-alias=1[[domain]]
server.ssl.enabled-protocols=TLSv1.2
security.require-ssl=true

# Debug Vaadin
vaadin.servlet.productionMode=false

# Change Port
server.port=443