mirror of
https://github.com/mailscope/kumomta.git
synced 2026-08-23 12:48:17 +00:00
Tom Mairs
127 lines
3.9 KiB
Markdown
127 lines
3.9 KiB
Markdown
# Building From Source
|
|
|
|
If pre-built binaries are not provided for your system of choice, of if you'd
|
|
like try your hand at extending KumoMTA, you'll need to build it from source.
|
|
|
|
If you are on Ubuntu or Rocky Linux and just want to try KumoMTA, rather than
|
|
build from source we recommend that you follow the instructions in the [Installing on Linux](linux.md) section.
|
|
|
|
## Prepare your environment
|
|
|
|
Read the [Environmental considerations](environment.md) before proceeding. You
|
|
will need a suitably sized server with all of the prerequisites in order to be
|
|
successful.
|
|
|
|
In addition, you will need to install some development packages.
|
|
|
|
## Obtain The Code
|
|
|
|
You will need `git`:
|
|
|
|
=== "RPM based systems"
|
|
```console
|
|
$ sudo dnf install -y git
|
|
```
|
|
|
|
=== "APT based systems"
|
|
```console
|
|
$ sudo apt install -y git
|
|
```
|
|
|
|
Then clone the repo:
|
|
|
|
```console
|
|
$ git clone https://github.com/KumoCorp/kumomta.git
|
|
$ cd kumomta
|
|
```
|
|
|
|
## Install Dependencies
|
|
|
|
The `get-deps.sh` script in the repo knows how to install dependencies for
|
|
various systems; you should run it the first time you clone the repo,
|
|
and may need to run it after running a pull to update the repo in the future:
|
|
|
|
```console
|
|
$ ./get-deps.sh
|
|
```
|
|
|
|
## Install Rust
|
|
|
|
You will need the Rust compiler to build KumoMTA.
|
|
|
|
We strongly recommend using [rustup](https://rustup.rs/) to install and manage
|
|
your Rust compiler. While some distributions offer a version of the Rust compiler,
|
|
it is often outdated.
|
|
|
|
If you are using a priviledged user, drop back to your non-priviledged user first:
|
|
|
|
```console
|
|
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
|
|
$ source ~/.profile
|
|
$ source ~/.cargo/env
|
|
$ rustc -V
|
|
```
|
|
|
|
## Building KumoMTA
|
|
|
|
With all the dependencies available, the actual build process is very simple:
|
|
|
|
```console
|
|
$ cargo build --release
|
|
```
|
|
|
|
This will build everything, leaving the binaries in the `target/release`
|
|
directory in the repo.
|
|
|
|
## Installing your build
|
|
There are a few helpers included that can build out the recommended directory structure.
|
|
|
|
```console
|
|
$ assets/build-rpm.sh
|
|
$ # or assets/build-deb.sh # if you are using a Debian derivative
|
|
$ assets/install.sh /opt/kumomta
|
|
```
|
|
A minimal policy is included in /opt/kumomta/share/minimal-init.lua that you can just copy to /opt/kumomta/etc/policy/init.lua. This is VERY minimal and you shoud definitely edit or create your own (see below)
|
|
|
|
|
|
## Creating the initial config
|
|
KumoMTA is now installed, but it requires a configuration policy so it knows how to behave.
|
|
The config is written in Lua and should live in /opt/kumomta/etc/policy. It **MUST** be named `init.lua` in order to work with systemctl services, so you should start by editing a file at `/opt/kumomta/etc/policy/init.lua` and populate it with at least the minimal config shown below. Alternately, there is a more substantial config sample [HERE](https://docs.kumomta.com/userguide/configuration/example/), but you must save it as `init.lua`.
|
|
|
|
```lua title="/opt/kumomta/etc/policy/init.lua"
|
|
--8<-- "init.lua"
|
|
```
|
|
|
|
|
|
## Running from your source directory
|
|
|
|
This command will bring `kumod` up to date (in case you made changes), and then try to launch it:
|
|
|
|
```console
|
|
$ KUMOD_LOG=kumod=info cargo run --release -p kumod -- --policy /opt/kumomta/etc/policy/init.lua
|
|
```
|
|
|
|
You can run as root using port 25 with this:
|
|
```
|
|
sudo KUMOD_LOG=kumod=debug /opt/kumomta/sbin/kumod --policy /opt/kumomta/etc/policy/sink.lua --user kumod&
|
|
```
|
|
|
|
In the above you are telling Cargo to run the Rust compiler to build an
|
|
optimized release version of kumod, then execute kumod using the policy file
|
|
called `init.lua`.
|
|
|
|
You can add debugging output by adjusting the `KUMOD_LOG` environment variable.
|
|
For exampe, setting `KUMOD_LOG=kumod=trace` in the environment will run with
|
|
very verbose logging.
|
|
|
|
|
|
## Staying up to date
|
|
|
|
To synchronize your repo with the latest changes:
|
|
|
|
```console
|
|
$ cd kumomta
|
|
$ git pull --rebase
|
|
$ cargo build --release
|
|
```
|