gador/smtprd-ng
1
0
Fork 0
mirror of https://seed.flo-the.dev/z3gWc1qgaeZaoGwL4WTstLNoqjayM.git synced 2025-12-06 04:47:35 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README

Browse Source 
Signed-off-by: Florian Brandes <florian.brandes@posteo.de>
This commit is contained in:
Florian Brandes
2024-07-12 11:50:26 +02:00
parent ffeb686fe0
commit f59934cfd0
2 changed files with 8 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.vscode/launch.json vendored
View File

@@ -11,6 +11,7 @@
"program": "${file}", "program": "${file}",
"console": "integratedTerminal", "console": "integratedTerminal",
"cwd": "${workspaceFolder}", "cwd": "${workspaceFolder}",
"justMyCode": false,
"env": {"PYTHONPATH": "${workspaceRoot}:${env:PYTHONPATH}"}, "env": {"PYTHONPATH": "${workspaceRoot}:${env:PYTHONPATH}"},
} }
] ]

18
README.md
View File

@@ -30,9 +30,7 @@ Clone this repo and run `nix-build .`
### nix (flakes) ### nix (flakes)
1. Clone the repo `nix run git+https://seed.radicle.garden/z3gWc1qgaeZaoGwL4WTstLNoqjayM.git -- --config config.ini`
2. `nix run . # just run or`
3. `nix build . # to build locally`
### python wheel ### python wheel
@@ -50,6 +48,7 @@ Note: `build` must be installed. You should use a `venv` for this.
### devenv ### devenv
Clone this repo and run `devenv shell` Clone this repo and run `devenv shell`
## Contributing ## Contributing
Contributions are always welcome! 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` 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 very early alpha ;-)
## License ## License
[AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html) [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html)
## Usage/Examples ## Usage/Examples
Copy config.example to config.ini and adjust to your usecase. 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 ```ini
smime_cert = /path/to/cert smime_cert = /path/to/cert
smime_cert_private = /path/to/cert.key smime_cert_private = /path/to/cert.key
smime_to_cert = /path/to/recipient_cert [emails]
monitoring.foo@example.com = /path/to/recipient_cert
``` ```
Where Where
- `smime_cert` is the path to the S/MIME certificate of the sender in PEM format. - `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_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. 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 - Add systemd service
- Clenup code - Cleanup code
- Add list of recipients and their certificates
- Add tests
## Acknowledgements ## Acknowledgements