summaryrefslogtreecommitdiff
path: root/flood/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'flood/README.md')
-rw-r--r--flood/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/flood/README.md b/flood/README.md
new file mode 100644
index 0000000..00a0636
--- /dev/null
+++ b/flood/README.md
@@ -0,0 +1,20 @@
+# Flood
+
+Web UI for rTorrent.
+
+## Setup
+
+1. Start:
+ ```
+ docker compose up -d
+ ```
+
+## Access
+
+- Web UI: `http://<host>:9091`
+
+## What to Configure
+
+- **rTorrent socket** — The volume `- /home/tyler/rtorrent/.session:/home/tyler/rtorrent/.session` must point to your rTorrent session directory (where `rpc.socket` lives). Update the host path if your rTorrent setup differs.
+- **Downloads volume** — `- /srv/torrents:/srv/torrents` mounts your torrent download directory. Update this to match your setup.
+- **User UID/GID** — The `user: "1000:1000"` line should match your rTorrent user. Change it if rTorrent runs as a different user.