Skip to content

mxhook start

Start MXHook services — the SMTP receiver and API server.

Usage

bash
mxhook start [flags]

Flags

FlagDefaultDescription
--smtp-addr0.0.0.0:25SMTP listen address
--smtp-domainlocalhostSMTP server domain (used in HELO/EHLO)
--api-addr0.0.0.0:8080REST API listen address
--db-urlPostgreSQL connection string (required)

All flags can also be set via environment variables. See Configuration.

Examples

Start with default settings:

bash
mxhook start --db-url "postgres://mxhook:mxhook@localhost:5432/mxhook?sslmode=disable"

Start with custom ports:

bash
mxhook start \
  --smtp-addr 0.0.0.0:2525 \
  --smtp-domain mail.yourdomain.com \
  --api-addr 0.0.0.0:9090 \
  --db-url "postgres://mxhook:mxhook@localhost:5432/mxhook?sslmode=disable"

Released under the Apache 2.0 License.