aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDiederick de Vries <diederick@diederickdevries.net>2018-06-14 19:36:05 +0200
committerDiederick de Vries <diederick@diederickdevries.net>2018-06-14 19:36:05 +0200
commit9dd98a7fda86ace5702a718ea8a5f458306f8e82 (patch)
tree86a02a160ae278788f75a2c672fae36d24d0be0d
parent6d8a6f687338d5ee70d627a32bdb8836925f068f (diff)
downloadcareless-9dd98a7fda86ace5702a718ea8a5f458306f8e82.tar.gz
careless-9dd98a7fda86ace5702a718ea8a5f458306f8e82.tar.bz2
careless-9dd98a7fda86ace5702a718ea8a5f458306f8e82.zip
Add example config
-rw-r--r--README.md29
-rw-r--r--example.conf9
2 files changed, 35 insertions, 3 deletions
diff --git a/README.md b/README.md
index b01840b..c6daacb 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,30 @@
1# Careless 1# Careless
2 2
3Automatically downloads articles from a specific Tiny Tiny RSS feed. 3Careless is a script that will download articles from a specific Tiny Tiny RSS feed.
4
5Tiny Tiny RSS is an RSS feed reader that you can install locally to assemble all your articles in a convenient place, much like Feedly and the former Google Reader. Many sites however publish only summaries or introductions over RSS, instead of the whole article. Careless is a small Groovy script that makes use of Tiny Tiny RSS's exposed API to find the links inside and if they are magnet links download the article using Transmission.
6
7Rename and change the file named `example.conf` and configure which directories, user, group and unix rights should be used:
8
9 trans The hostname of the computer where Tranmission runs
10 ttrss The url to Tiny Tiny RSS, ending on "/api/"
11 user Your username on Tiny Tiny RSS
12 pass Your user's password on Tiny Tiny RSS
13 feed The number of the feed that contains the links, enclosed in ""
14
15 tv The directory under which the downloaded files are stored
16 allowed a list of allowed file types
17 nrs a regex matching with how the original filenames state their series and episode number.
18
19You can run the script manually (use `sudo` to set the unix user, group and rights):
20
21 $ sudo groovy careless.groovy properties.conf
22
23but you shouldn't. The two `systemd` files will let you run the script automatically every hour. In `careless.service`, adapt the line starting with `ExecStart` to point it to where you install Careless. Put both files in `/etc/systemd/system/` and do:
24
25 $ sudo systemctl start careless.timer
26 $ sudo systemctl enable careless.timer
27
28If your system doesn't use `systemd`, you can trigger Careless with inotify(7) or a cron job.
4 29
5Tiny Tiny RSS is an RSS feed reader that you can install locally to assemble all your articles in a convenient place, much like Feedly and the former Google Reader. Many sites however publish only summaries or introductions over RSS, instead of the whole article. Careless is a small Groovy script that makes use of Tiny Tiny Rss's exposed API to find the links inside and if they are magnet links download the article using Transmission.
6 30
7Populate the variables at the start of the script to point it towards your local Tiny Tiny RSS installation and the right feed.
diff --git a/example.conf b/example.conf
new file mode 100644
index 0000000..e7ab94c
--- /dev/null
+++ b/example.conf
@@ -0,0 +1,9 @@
1trans = ""
2ttrss = "https://localhost/tt-rss/api/"
3user = ""
4pass = ""
5feed = ""
6
7tv = "TV"
8allowed = ['mkv', 'mp4', 'mpg', 'avi']
9nrs = "[Ss]?[0-9]{1,2}[EeXx][0-9]{1,2}"