version 0.1.0

- add nixosModules config part to readme
- cleanup
- add version tag 0.1.0

Signed-off-by: Florian Brandes <florian.brandes@posteo.de>
This commit is contained in:
2024-07-12 21:48:00 +02:00
parent e860cf24f1
commit f40359baec
5 changed files with 55 additions and 25 deletions

View File

@@ -17,7 +17,7 @@ For now, this is a proof-of-concept.
## Features
- Relay emails received on a locally listening SMTP server
- Encrypt and sign the relayed mails (experimental)
- Encrypt and sign the relayed mails
## Installation/Hacking
@@ -57,7 +57,7 @@ Please read https://radicle.xyz/guides/user to get used to clone this repo with
If you just want to clone the repo without `radicle` you can clone the repo with `git clone https://seed.radicle.garden/z3gWc1qgaeZaoGwL4WTstLNoqjayM.git smtprd-ng`
Beware: This is very early alpha ;-)
Beware: This is alpha ;-)
## License
@@ -86,13 +86,58 @@ Where
Plese note: Right now, there is no way to set a password, so the private key is unprotected and should only be used for this automation and have appropiate file permissions. I might add the option to set a password through the config file in the future, though.
### Systemd
An example `systemd` file is in the `sytemd` subfolder. Be sure to replace @smtprd@ with a path to the python executable.
For `NixOS` you yan use the provided `nixosModule` like so:
```nix
# flake.nix
{
inputs.smtp = {
url = "git+https://seed.radicle.garden/z3gWc1qgaeZaoGwL4WTstLNoqjayM.git";
};
outputs = inputs@{ ... }: {
nixosConfigurations = {
my-config = inputs.nixpkgs.lib.nixosSystem {
system = "x86_64-linux";
modules = [
inputs.smtp.nixosModules.smtprd-ng
{
services.smtprd-ng = {
enable = true;
client = {
hostname = "smtp.example.com";
username = "username";
password_file = "/etc/smtp_pw";
sender = "username@example.com";
start_tls = true;
smime_cert = "${./smime.crt}";
smime_cert_private = "/etc/private.key";
};
emails = {
"monitor@example.com" = "${./cert_for_monitor_example_com}";
"second_monitor@example.com" = "";
};
};
}
];
};
};
};
}
```
## Roadmap
- Add wheel for pypi
- Add systemd service
- Cleanup code