Skip to content
Daniel Müller edited this page Feb 9, 2021 · 3 revisions

Config

You can configure some parts of MailPie yourself or just use the defaults. If you want to change e.g. the IMAP Port there are two possible ways:

  • A config file
  • CLI arguments (flags)

Config file

On the first start of MailPie, it will create a config file with the default values. By default, the config path is ~/.config/mailpie.yml. You can change the config path by executing mailpie with ./mailpie -config /your/preferred/config/path. Currently config files are all or nothing. If no file at this location exists, MailPie will create one. If there is an empty file with this name, MailPie will not override it.

Docker

In the Docker image, the default config path is /root/mailpie.yml

Flags

Everything you can configure within the config file, you can also configure with flags. Flags always have a higher priority than the config file.

Flag Syntax

All MailPie flags begin with a single -. There are value flags and bool flags. A value flag always expects a subsequent value (-flag value). Bool flags are either set or not set.

Configurations

Config Flag Description Default
- -config <path> Define the config path $HOME/.config/mailpie.yml
disable_http -disableHttp Disables the SPA service false
disable_imap -disableImap Disables the IMAP service false
disable_smtp -disableSmtp Disable the SMTP service false
networkconfigs:http:host -httpHost <host> Set the host the HTTP server should listen on 0.0.0.0
networkconfigs:http:port -httpPort <port> Set the port the HTTP server should listen on 8000
networkconfigs:imap:host -imapHost <host> Set the host the IMAP server should listen on 0.0.0.0
networkconfigs:imap:port -imapPort <port> Set the port the IMAP server should listen on 1143
networkconfigs:smtp:host -smtpHost <host> Set the host the SMTP server should listen on 0.0.0.0
networkconfigs:smtp:port -smtpPort <port> Set the port the SMTP server should listen on 1025
log_level -logLevel <level>
Possible log leves are:
        0 - Panic
        1 - Fatal
        2 - Error
        3 - Warn
        4 - Info
        5 - Debug
        6 - Trace
3
Clone this wiki locally