aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: f63ce4837abdd8fe87ad417a7ea3150f7da61698 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# rssmail

An RSS-to-email aggregator tool.

The aim of this tool is to be simple to configure and run.

## Installation
```
git clone https://git.sr.ht/~panda-roux/rssmail
cd rssmail
cmake . && make
sudo make install
```

## Usage
```
rssmail <first.conf> [second.conf ...]
```

See example.conf for available configuration options and aliases.

Configuration 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:

```
./rssmail server.conf cat-feeds.conf cat-lovers.conf
./rssmail server.conf mushroom-feeds.conf shroom-lovers.conf


server.conf:

  username: admin@example.com
  password: hatemyjob
  host: mail.example.com
  port: 465
  from: mailer@example.com


cat-feeds.conf:

  max_age: 1440
  uri: https://cats.example.com/rss.xml
  uri: https://kittens.example.com/rss
  uri: https://tabbies.example.com/feed
  ...


mushroom-feeds.conf:

  max_age: 1440
  uri: https://mush.example.com/rss
  uri: https://mycelium.example.com/feed&type=rss
  ...


cat-lovers.conf:

  to: cats-list@example.com
  recipient: alice@example.com
  recipient: bob@example.com
  ...


shroom-lovers.conf:

  to: myco-list@example.com
  recipient: jake@example.com
  recipient: balthazar@example.com
  recipient: alice@example.com
  ...
```

## Runtime Dependencies
- LibXML2
- LibCURL

## Build Dependencies
- GCC or Clang
- CMake