kosmos/husk-milter
8
0
Fork 0
Code Issues Packages Activity

Adjust README

Browse Source 
- Update the README to include the changes for milestone 3.
This commit is contained in:
Malte Meiboom
2026-05-27 11:28:53 +02:00
parent a007a296ff
commit 957c8b8979
1 changed files with 12 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -71
View File
@@ -8,82 +8,23 @@ Husk is written in Rust and uses Sequoia PGP for encryption and certificate hand
## Status
Milestone 2 is reached:
Milestone 3 is reached and with it Husk has aquired a set of new features:
Husk can encrypt passing mails for simple cases, meaning:
- Online sources (keyservers, WKD, DANE) are now queried for missing
certificates.
- Introducers are now available: certificates are only used if they are
certified by an introducer and match its list of configured domains.
- Locals are available: These are certificates hand picked and added
by the administrator.
- for all recipients of an email, a valid certificate is locally available.
- if that is not the case, Husk will not modify the email.
- Husk will not query keyservers (or other sources) for certificates - this is part of milestone 3.
## Documentation
Please be patient.
The documentation (with install instructions) can be found [here](https:://www.husk-project.org/documentation).
## Build
Make sure that you have a toolchain for Rust installed.
Building:
```
$ git clone https://gitlab.com/husk-project/husk-milter.git
$ cd husk-milter
$ cargo build --release
```
This creates the binary `./target/release/husk`.
## Installation
To use with `postfix`:
- configure husk, there is an example configuration file in `./config/config.toml`.
```
#
# Husk config file
#
connection = "localhost:3000"
logfile_config = "./config/log4rs.yml"
```
Husk uses `log4rs` for logging. There is an example configuration in the
`./config` subdirectory as well.
- Configure `postfix`:
Make sure that the `main.cf` configuration file contains a line like:
```
smtpd_milters = inet:localhost:3000
```
`smtpd_milters` is used to register milters with postfix, there might be
more than one. The string `inet:localhost:3000` corresponds to the
`connection` setting in `config.toml`.
You can add the line
```
non_smtpd_milters = $smtpd_milters
```
directly after the line containing `smtpd_milters`, so that local calls to `sendmail` will also invoke `Husk`.
- Start the milter:
Assuming you are in the root directory of the project:
```
$ ./target/release/husk ./config/config.toml
```
- Restart postfix:
In case you are using systemd:
```
# systemctl restart postfix.service
```
- Send a mail and check the logfile.
## Website
This project has a [website](https:://www.husk-project.org/) with more background
information.
## Funding