Configuration

djehooty-backend

User Directory

The User Directory folder contains the configuration, database, and user files for Djehooty.

By default, this folder is set to ~/Djehooty on Linux.

When it doesn't exist, User Directory is created on the first server startup.

With Docker

You can change this folder by mounting a different Docker volume to /app/data. Simply replace ~/Djehooty in your docker-compose.yml with the path of your choice or modify the command line parameters. Make sure to properly set the folder permissions as explained in the Installation section.

With the djehooty-backend Makefile

You can also change this folder by using the DEV_USERDIR environment variable when using the Makefile.

make dev DEV_USERDIR=~/Djehooty-dev2 # Override user directory
make run DEV_USERDIR=~/Djehooty-dev2 # Override user directory

With the djehooty-backend binary

You can change this folder using the --userdir option

djehooty-backend --userdir ~/Documents/Djehooty

Configuration file

djehooty-backend automatically looks for the config.yaml file in the User Directory to load various parameters on server startup. When config.yaml doesn't exist, default parameters are automatically loaded without creating a file.

To modify djehooty-backend parameters, if it doesn't already exist, create a config.yaml file at the root of the User Directory folder.

Port

You can change the port number if the default value doesn't suit you

port: 8181

Development

You can enable development mode with dev_mode.

Then the dev_latency_ms option allows you to introduce latency in the response of all REST API endpoints.

dev_mode: true
dev_latency_ms: 1000