diff --git a/README.md b/README.md index 490ed2d..0a57120 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

- Speedrr + speedrr
-

Speedrr - Dynamic Upload Speed Manager for Torrenting

+

speedrr - Dynamic Upload Speed Manager for Torrenting

Change your torrent client's upload speed dynamically, on certain events such as: @@ -42,6 +42,20 @@ docker run -d itschasa/speedrr ``` +### Unraid +1. Open your console and run the following command: +``` +cd /boot/config/plugins/dockerMan/templates-user && touch my-speedrr.xml && nano my-speedrr.xml +``` +2. Go to speedrr-unraid.xml, and copy and paste it into your console. +3. Press Ctrl+O, then Enter, then Ctrl+X (to save the file and exit). +4. Open your WebUI > `Docker` > `Add Container`. +5. Click `Select a template`, and select `speedrr`. +6. The options should be fine as they are defaulted. Apply changes. +7. Using the template, create config.yaml in your /appdata/speedrr/ folder, and fill out the config. +8. Start/Restart the container in the WebUI. +9. Check everything is working in the logs (Docker Logs). + ### Source 1. Download the source code. 2. Install Python 3.10 (other versions should work). diff --git a/images/speedrr.png b/images/speedrr.png new file mode 100644 index 0000000..b622e00 Binary files /dev/null and b/images/speedrr.png differ diff --git a/images/speedrr_text.png b/images/speedrr_text.png new file mode 100644 index 0000000..c9f1d97 Binary files /dev/null and b/images/speedrr_text.png differ diff --git a/speedrr-unraid.xml b/speedrr-unraid.xml new file mode 100644 index 0000000..2394ab5 --- /dev/null +++ b/speedrr-unraid.xml @@ -0,0 +1,28 @@ + + + speedrr + itschasa/speedrr + https://registry.hub.docker.com/r/itschasa/speedrr/ + host + + sh + false + https://github.com/itschasa/speedrr + + Dynamically manage upload speeds on torrent clients, with Plex/Jellyfin intergration.[br] + Preset config available at: https://github.com/itschasa/speedrr/blob/main/config.yaml [br] + Config needs to be saved in your /mnt/user/appdata/speedrr/ folder. + + Tools:Utilities MediaApp:Other MediaApp:Video MediaServer:Video + + https://raw.githubusercontent.com/itschasa/speedrr/master/speedrr-unraid.xml + https://raw.githubusercontent.com/itschasa/speedrr/master/images/speedrr.png + + + + + + + + + \ No newline at end of file