aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorpanda-roux <contact@panda-roux.pub>2021-08-22 11:02:16 -0700
committerpanda-roux <contact@panda-roux.pub>2021-08-22 11:02:16 -0700
commitab5982443efd3969ae9b240be7f52e29fc8409bd (patch)
treed9ad4c01ae511341203fe884306b8479f27d6a99 /README.md
adding files
Diffstat (limited to 'README.md')
-rw-r--r--README.md70
1 files changed, 70 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..453eeed
--- /dev/null
+++ b/README.md
@@ -0,0 +1,70 @@
1# rssmail
2
3An RSS-to-email aggregator tool.
4
5The aim of this tool is to be simple to configure and run.
6
7## Usage
8```
9./rssmail <first.conf> [second.conf ...]
10```
11
12See example.conf for available configuration options and aliases.
13
14Configuration 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:
15
16```
17./rssmail server.conf cat-feeds.conf cat-lovers.conf
18./rssmail server.conf mushroom-feeds.conf shroom-lovers.conf
19
20
21server.conf:
22
23 username: admin@example.com
24 password: hatemyjob
25 host: mail.example.com
26 port: 465
27 from: mailer@example.com
28
29
30cat-feeds.conf:
31
32 max_age: 1440
33 uri: https://cats.example.com/rss.xml
34 uri: https://kittens.example.com/rss
35 uri: https://tabbies.example.com/feed
36 ...
37
38
39mushroom-feeds.conf:
40
41 max_age: 1440
42 uri: https://mush.example.com/rss
43 uri: https://mycelium.example.com/feed&type=rss
44 ...
45
46
47cat-lovers.conf:
48
49 to: cats-list@example.com
50 recipient: alice@example.com
51 recipient: bob@example.com
52 ...
53
54
55shroom-lovers.conf:
56
57 to: myco-list@example.com
58 recipient: jake@example.com
59 recipient: balthazar@example.com
60 recipient: alice@example.com
61 ...
62```
63
64## Runtime Dependencies
65- LibXML2
66- LibCURL
67
68## Build Dependencies
69- GCC or Clang
70- CMake