Configuration

Configuration can be tedious—but it’s also one of the most important aspects, and good documentation makes all the difference. The sections listed below provide detailed explanations for each configuration area.

Before diving into configuring Dementor, it’s essential to understand the structure of the configuration file. The configuration is written using the TOML format. Make sure you’re familiar with TOML’s syntax and concepts to effectively work with Dementor.

Main Section

Learn how to enable or disable specific protocol services.

main.html

Database

Covers configuration options for credential storage and database location.

database.html

Globals

Define settings that apply across multiple services or protocols.

globals.html

Protocols

Customize behavior for each protocol-specific service.

protocols.html

Logging

Adjust logging behavior and debug output for Dementor.

logging.html

Hint

Need an example configuration file? No problem, its available on GitHub: Dementor.conf

To get the paths and directories of Dementor’s installation files and assets, use dementor.paths:

$ python3 -m dementor.paths
DefaultWorkspace  : ~/.dementor
AssetsPath        : /.../dementor/assets
ConfigPath        : ~/.dementor/Dementor.toml
BannerPath        : /.../dementor/assets/banner.txt
DefaultConfigPath : /.../dementor/assets/Dementor.toml
HTTPTemplatesPath : /.../dementor/assets/www