Laurent/mailman3_webhook_archiver
1
0
Fork 0
mirror of https://github.com/Laurent2916/mailman3_webhook_archiver.git synced 2024-11-09 23:12:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

📝 update syntax highlighting in README.md

Browse source
This commit is contained in:
Laureηt 2023-05-19 18:43:33 +00:00 committed by GitHub
parent fdaf7e8654
commit 9b909fc88c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -13,7 +13,7 @@ Install the package using pip:
pip install git+https://github.com/Laurent2916/mailman3_webhook_archiver.git pip install git+https://github.com/Laurent2916/mailman3_webhook_archiver.git
``` ```
## Manual install ## Manual install (not recommended)
Clone the repository: Clone the repository:
```bash ```bash
@ -33,7 +33,7 @@ cp -r mailman3_webhook_archiver /path/to/.venv/lib/python3.11/site-packages/
The archiver loads its configuration using an external configuration file. The archiver loads its configuration using an external configuration file.
Create and fill `/etc/mailman3/mailman-webhook-archiver.cfg` with the relevant informations. Create and fill `/etc/mailman3/mailman-webhook-archiver.cfg` with the relevant informations.
```conf ```ini
[global] [global]
url = https://webhook.example.com/foo/bar url = https://webhook.example.com/foo/bar
key = SUPER_SECRET_TOKEN_KEY key = SUPER_SECRET_TOKEN_KEY
@ -45,7 +45,7 @@ monitored_lists = my_mailing_list, another_list, foo, bar, test
Modify the mailman configuration to enable the newly added archiver. Modify the mailman configuration to enable the newly added archiver.
Append the following to `/etc/mailman3/mailman.cfg`. Append the following to `/etc/mailman3/mailman.cfg`.
```conf ```ini
[archiver.mailman3_webhook_archiver] [archiver.mailman3_webhook_archiver]
class: mailman3_webhook_archiver.WebhookArchiver class: mailman3_webhook_archiver.WebhookArchiver
configuration: /etc/mailman3/mailman3_webhook_archiver.cfg configuration: /etc/mailman3/mailman3_webhook_archiver.cfg