aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md78
-rw-r--r--example.conf10
2 files changed, 38 insertions, 50 deletions
diff --git a/README.md b/README.md
index f63ce48..6fdac9e 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
1# rssmail 1# rssmail
2 2
3An RSS-to-email aggregator tool. 3An RSS-to-email aggregator.
4 4
5The aim of this tool is to be simple to configure and run. 5The aim of this tool is to be simple to configure and run.
6 6
7## Installation 7## Installation
8``` 8```
9git clone https://git.sr.ht/~panda-roux/rssmail 9git clone https://git.panda-roux.dev/rssmail.git
10cd rssmail 10cd rssmail
11cmake . && make 11cmake . && make
12sudo make install 12sudo make install
@@ -17,58 +17,46 @@ sudo make install
17rssmail <first.conf> [second.conf ...] 17rssmail <first.conf> [second.conf ...]
18``` 18```
19 19
20## Configuration
20See example.conf for available configuration options and aliases. 21See example.conf for available configuration options and aliases.
21 22
22Configuration can be split across multiple files. A use-case for this might be one in which you'd like to send different digests to different sets of recipients using a common set SMTP parameters: 23### SMTP configuration
23 24```
25# server information
26username sender@example.com
27password hunter2
28host mail.example.com
29port 465
30
31# outgoing mail headers
32from sender@example.com
33to list@example.com
34subject RSS Mailing List
35
36# recipient addresses
37recipient contact@panda-roux.dev
38recipient someone@example.com
39recipient someone-else@example.com
24``` 40```
25./rssmail server.conf cat-feeds.conf cat-lovers.conf
26./rssmail server.conf mushroom-feeds.conf shroom-lovers.conf
27
28
29server.conf:
30
31 username: admin@example.com
32 password: hatemyjob
33 host: mail.example.com
34 port: 465
35 from: mailer@example.com
36
37
38cat-feeds.conf:
39
40 max_age: 1440
41 uri: https://cats.example.com/rss.xml
42 uri: https://kittens.example.com/rss
43 uri: https://tabbies.example.com/feed
44 ...
45
46
47mushroom-feeds.conf:
48
49 max_age: 1440
50 uri: https://mush.example.com/rss
51 uri: https://mycelium.example.com/feed&type=rss
52 ...
53
54
55cat-lovers.conf:
56 41
57 to: cats-list@example.com 42### RSS feed configuration
58 recipient: alice@example.com 43```
59 recipient: bob@example.com 44useragent rssmail by panda-roux (https://sr.ht/~panda-roux/rssmail/)
60 ...
61 45
46# feeds
47feed_uri https://itsgoingdown.org/feed
48feed_uri https://crimethinc.com/rss
49feed_uri https://www.revolutionbythebook.akpress.org/feed/
50feed_uri https://channelzeronetwork.com/rss
62 51
63shroom-lovers.conf: 52# maximum age of posts to include in the digest (minutes)
53max_age 1440
64 54
65 to: myco-list@example.com
66 recipient: jake@example.com
67 recipient: balthazar@example.com
68 recipient: alice@example.com
69 ...
70``` 55```
71 56
57### Files
58If multiple configuration files are specified via command-line arguments, they will be treated as though concatenated in a single file. This allows for a DRY approach in which common options (such as SMTP info) may be specified in a single file and used with different feed and recipient lists.
59
72## Runtime Dependencies 60## Runtime Dependencies
73- LibXML2 61- LibXML2
74- LibCURL 62- LibCURL
diff --git a/example.conf b/example.conf
index 947e4b9..5059136 100644
--- a/example.conf
+++ b/example.conf
@@ -33,6 +33,11 @@ from sender@example.com
33to list@example.com 33to list@example.com
34subject RSS Mailing List 34subject RSS Mailing List
35 35
36# recipient addresses
37recipient contact@panda-roux.dev
38recipient someone@example.com
39recipient someone-else@example.com
40
36 41
37# -------------------------------------------------- 42# --------------------------------------------------
38# RSS feed configuration 43# RSS feed configuration
@@ -49,11 +54,6 @@ feed_uri https://channelzeronetwork.com/rss
49# maximum age of posts to include in the digest (minutes) 54# maximum age of posts to include in the digest (minutes)
50max_age 1440 55max_age 1440
51 56
52# recipients are listed on separate lines beginning with the "recipient" token
53recipient contact@panda-roux.dev
54recipient someone@example.com
55recipient someone-else@example.com
56
57 57
58# -------------------------------------------------- 58# --------------------------------------------------
59# Miscellaneous 59# Miscellaneous