aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..37431eb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# transmission-hacks
+
+Just a bunch of scripts to automate some tasks in transmission.
+
+# Settings
+
+| Variable Name | Default / Description |
+|--------------------- |--------------------------------------------------------------------------------------- |
+| `CRON_LOG_LEVEL` | `0` / Tell cron what to log about jobs |
+| `CRON_EXPRESSION` | `* * * * *` / A cron expression to indicate how often to run **all** scripts |
+| `TRANSMISSION_HOST` | `localhost` / The host where transmission runs |
+| `TRANSMISSION_PORT` | `9091` / Port where transmission is listening |
+| `DELETE_TAG_0_NAME` | No default. A transmission tag to match torrents and delete by age. |
+| `DELETE_TAG_0_AGE` | No default. Time (`1d`, `1w`...etc) string, torrents older than that will be deleted. |