about summary refs log tree commit diff
path: root/users/Profpatsch/whatcd-resolver/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'users/Profpatsch/whatcd-resolver/README.md')
-rw-r--r--users/Profpatsch/whatcd-resolver/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/users/Profpatsch/whatcd-resolver/README.md b/users/Profpatsch/whatcd-resolver/README.md
new file mode 100644
index 000000000000..d1902e546a4f
--- /dev/null
+++ b/users/Profpatsch/whatcd-resolver/README.md
@@ -0,0 +1,21 @@
+# whatcd-resolver
+
+To run:
+
+```
+ninja run-services
+```
+
+in one terminal (starts the background tasks)
+
+```
+ninja run
+```
+
+to start the server. It runs on `9092`.
+
+You need to be in the `nix-shell` in `./..`.
+
+You need to set the `pass` key `internet/redacted/api-keys/whatcd-resolver` to an API key for RED.
+
+You need to have a transmission-rpc-daemon listening on port `9091` (no auth, try ssh port forwarding lol).