aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 6fdac9eca89f8f3936feff2b0c9f21f498ee09a2 (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
# rssmail

An RSS-to-email aggregator.

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

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

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

## Configuration
See example.conf for available configuration options and aliases.

### SMTP configuration
```
# server information
username            sender@example.com
password            hunter2
host                mail.example.com
port                465

# outgoing mail headers
from                sender@example.com
to                  list@example.com
subject             RSS Mailing List

# recipient addresses
recipient           contact@panda-roux.dev
recipient           someone@example.com
recipient           someone-else@example.com
```

### RSS feed configuration
```
useragent           rssmail by panda-roux (https://sr.ht/~panda-roux/rssmail/)

# feeds
feed_uri            https://itsgoingdown.org/feed
feed_uri            https://crimethinc.com/rss
feed_uri            https://www.revolutionbythebook.akpress.org/feed/
feed_uri            https://channelzeronetwork.com/rss

# maximum age of posts to include in the digest (minutes)
max_age             1440

```

### Files
If 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. 

## Runtime Dependencies
- LibXML2
- LibCURL

## Build Dependencies
- GCC or Clang
- CMake