mirror of
https://github.com/mailscope/kumomta.git
synced 2026-09-06 18:48:57 +00:00
86 lines
2.1 KiB
Markdown
86 lines
2.1 KiB
Markdown
# Installing KumoMTA in a Docker container
|
|
|
|
Our CI builds the latest version of our image and publishes it
|
|
to the GitHub Container registry.
|
|
|
|
You'll need a policy script in order to start kumo.
|
|
|
|
Create a file named `init.lua` with these contents:
|
|
|
|
```lua
|
|
local kumo = require 'kumo'
|
|
-- This config acts as a sink that will discard all received mail
|
|
|
|
kumo.on('init', function()
|
|
-- Listen on port 25
|
|
kumo.start_esmtp_listener {
|
|
listen = '0:25',
|
|
-- allow all clients to send mail
|
|
relay_hosts = { '0.0.0.0/0' },
|
|
}
|
|
|
|
-- Define the default "data" spool location.
|
|
-- This is unused by this config, but we are required to
|
|
-- define a default spool location.
|
|
kumo.define_spool {
|
|
name = 'data',
|
|
path = '/tmp/kumo-sink/data',
|
|
}
|
|
|
|
-- Define the default "meta" spool location.
|
|
-- This is unused by this config, but we are required to
|
|
-- define a default spool location.
|
|
kumo.define_spool {
|
|
name = 'meta',
|
|
path = '/tmp/kumo-sink/meta',
|
|
}
|
|
end)
|
|
|
|
kumo.on('smtp_server_message_received', function(msg)
|
|
-- Accept and discard all messages
|
|
msg:set_meta('queue', 'null')
|
|
end)
|
|
```
|
|
|
|
When we launch the image, we want to mount our `init.lua` file into the image
|
|
and tell it to use it. The default location for this is `/opt/kumomta/etc/policy`:
|
|
|
|
```console
|
|
$ sudo docker run --rm -p 2025:25 \
|
|
-v .:/opt/kumomta/etc/policy \
|
|
--name kumo-sink \
|
|
ghcr.io/KumoCorp/kumomta:main
|
|
```
|
|
|
|
## Building your own KumoMTA container image
|
|
|
|
You need `git` to clone the repo:
|
|
|
|
=== "RPM based systems"
|
|
```console
|
|
$ sudo dnf install -y git
|
|
```
|
|
|
|
=== "APT based systems"
|
|
```console
|
|
$ sudo apt install -y git
|
|
```
|
|
|
|
Then clone the repo and run the image builder script:
|
|
|
|
```console
|
|
$ git clone https://github.com/KumoCorp/kumomta.git
|
|
$ cd kumomta
|
|
$ ./docker/kumod/build-docker-image.sh
|
|
```
|
|
|
|
This should result in something roughly like this:
|
|
|
|
```console
|
|
$ docker image ls kumomta/kumod
|
|
REPOSITORY TAG IMAGE ID CREATED SIZE
|
|
kumomta/kumod latest bbced15ff4d1 3 minutes ago 116MB
|
|
```
|
|
|
|
You can then run that image in the same way as shown in the previous section.
|