Configuration
MailerQ has lots of configuration options. Each option can be supplied in three different ways:
- Via a configuration file. Its location is
/etc/mailerq/config.txt. - Via a command-line option.
- Via an environment variable.
When an environment variable is set, it overrides the value specified in the configuration file. Similarly, when a command-line option is provided, it overrides both the configuration file as well as the environment variable.
Overridability
Overridability of keys follows a simple pattern. If you want to override such a
key via the command-line, add two dashes in front of the key name. If you want
to override the key via an environment variable, uppercase the key, prepend the
string MAILERQ_ to it, and replace dashes with underscores.
As an example, the configuration key rabbitmq-address can also be given on
the command-line by running
mailerq --rabbitmq-address=amqp://rabbit.example.comMailerQ will then use rabbit.example.com for its RabbitMQ server, instead of
the value that's given in /etc/mailerq/config.txt. Similarly, you can provide
an environment variable:
MAILERQ_RABBITMQ_ADDRESS=amqp://rabbit.example.com mailerqThe above will cause MailerQ to use rabbit.example.com. If you supply both,
then the command-line override "wins".
In-depth settings
In the rest of this documentation, we only denote the name of the configuration key as specified in the configuration file.
The documentation for the various options is split up in different sections. Please select the section that you're interested in or find the desired setting in the A-Z settings overview.
- RabbitMQ settings
- Cluster settings
- Database settings
- Message store settings
- Logging
- Smarthost & debugging
- Management console
- Responsive Email
- Multiple instances
- DNS settings
- Other options
Are you looking for more settings?
The config file is not the only place where MailerQ gets its configuration from. Most of the settings relevant for deliveries are not kept in the config file, but are loaded from a relational database. The web based management console allows you to read or change these settings, and you can of course also access the database directly to read or update these settings.
