The Configuration File

The Configuration File

This page aims to assist in explaining the config.json used to setup the application.

Where to put it

The file must be mounted into /app/config.json

What do the options mean

Name	Possible Values	Explanation	Mandatory
admin.mail	any valid email	the email of the very first user
admin.password	any string	the password of the very first user
database.user	any string	used for the postgres user
database.password	any string	used for the postgres user
database.host	any hostname	used as connection to the db
database.port	any valid port	the port where the db listens
database.name	any string	the name of the database
system.domain	valid domain	The domain under which the software is served	x
system.mode	PROD | DEV	In which environment mode should the software start, DEV seeds the database with example data and is less secure	x
system.pepper	any string	used to scramble the hash, see e.g. OWASP
system.loglevel	INFO | WARN | ERROR	Which logs should be shown in the server logs
system.frontend.default_language	en | de	The default language used, if no language cookie is set
system.frontend.max_inputs.x	positive integers	The maximum allowed number of characters in each field. 0 will use the defaults

Default values

This table shows the default values for the above configurations

Config Path	Default Value
admin.mail	admin@kummer.kasten
admin.password	DEV: admin, PROD: generated, search the logs
system.frontend.default_language	de
system.loglevel	INFO
database.host	localhost
database.port	5432
database.user	kummerkasten_user

Default Values for Max Inputs

I am lazy in writing this documentation, so all paths here have the suffix system.frontend.max_inputs

Path	Default Value
public.title	100
public.content	2000
private.titles	100
private.labels	100
private.names	50
private.about	2000
private.faqs.quesitons	100
private.faqs.answers	500

Important Notes

• All values in this file are overridden, if the value is present es ENV-Variable
• Changing the pepper results in failing authentication. This does NOT happen to the initial admin user. You can fix this by either reverting the value or resetting all passwords as the initial admins
• If you use the postgres service inside the docker-compose.yml you do not have to fill out the database section, as long as you provide the .env to both the database and the app. (Postgres variables are parsed into the app automatically and config values are overwritten by them)