RSSingle/README.md
Dom Rodriguez d3262d89b5
[init](codebase): Initial commit
Total rewrite of singlerss, better and better than before!

Signed-off-by: Dom Rodriguez <shymega@shymega.org.uk>
2020-08-18 00:24:10 +01:00

1.2 KiB

singlerss

Description

singlerss combines all feeds described in a OPML file into one feed. This can either be outputted into stdout or a file, as specifed by program arguments, and configured by the environment variables.

Configuration

SingleRSS is configured by environment variables.

See .env.sample. You must copy .env.sample to .env.

SINGLERSS_FEED_OUT_PATH defines the relative OR absolute path to output the feed to, IF SINGLERSS_FEED_OUT_TYPE is set to file. If SINGLERSS_FEED_OUT_TYPE is set to stdout, you must redirect output to the file you want it written to.

SINGLERSS_FEED_LIST_PATH must be set to the input list of feeds you want to be collated into one feed. This must be a newline delimited file of URLs.

Running

You may run this directly, after sourcing .env and exporting the variables, with ./singlerss.py. Alternatively, I have provided a systemd unit and timer, which I will offer support for, and a basic crontab. I do not use cron, so I cannot offer support for it.

Licensing

This program is licensed under the Apache License 2.0.

Copyright (c) Dom Rodriguez (shymega) 2020.