From f59934cfd0a87ba9c1a2fd44135d7a5ec9ee5e85 Mon Sep 17 00:00:00 2001 From: Florian Brandes Date: Fri, 12 Jul 2024 11:50:26 +0200 Subject: [PATCH] update README Signed-off-by: Florian Brandes --- .vscode/launch.json | 1 + README.md | 18 +++++++----------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/.vscode/launch.json b/.vscode/launch.json index 0a879e5..d60a446 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -11,6 +11,7 @@ "program": "${file}", "console": "integratedTerminal", "cwd": "${workspaceFolder}", + "justMyCode": false, "env": {"PYTHONPATH": "${workspaceRoot}:${env:PYTHONPATH}"}, } ] diff --git a/README.md b/README.md index 208fd77..9861eb0 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,7 @@ Clone this repo and run `nix-build .` ### nix (flakes) -1. Clone the repo -2. `nix run . # just run or` -3. `nix build . # to build locally` +`nix run git+https://seed.radicle.garden/z3gWc1qgaeZaoGwL4WTstLNoqjayM.git -- --config config.ini` ### python wheel @@ -50,6 +48,7 @@ Note: `build` must be installed. You should use a `venv` for this. ### devenv Clone this repo and run `devenv shell` + ## Contributing Contributions are always welcome! @@ -59,11 +58,11 @@ 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 ;-) + ## License [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html) - ## Usage/Examples Copy config.example to config.ini and adjust to your usecase. @@ -77,12 +76,13 @@ If you want to give sign and encryption a go, you need to set ```ini smime_cert = /path/to/cert smime_cert_private = /path/to/cert.key -smime_to_cert = /path/to/recipient_cert +[emails] +monitoring.foo@example.com = /path/to/recipient_cert ``` Where - `smime_cert` is the path to the S/MIME certificate of the sender in PEM format. - `smime_cert_private` is the path to the S/MIME priate key of the sender in PEM format -- `smime_to_cert` is the path to a S/MIME certificate of the recipiant in PEM or DER format. +- `monitoring.foo@example.com`is the recipient and `/path/to/recipient_cert` is the path to the certificate of the recipient in PEM format 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. @@ -93,11 +93,7 @@ Plese note: Right now, there is no way to set a password, so the private key is - Add systemd service -- Clenup code - -- Add list of recipients and their certificates - -- Add tests +- Cleanup code ## Acknowledgements