add: unraid template, images; edit: readme

README.md

@@ -1,7 +1,7 @@
 <p align="center">
- <img src="https://i.imgur.com/XgRpU5l.png" alt="Speedrr" width="336" height="84">
+ <img src="https://raw.githubusercontent.com/itschasa/speedrr/master/images/speedrr_text.png" alt="speedrr" width="336" height="84">
  <br/>
- <h1>Speedrr - Dynamic Upload Speed Manager for Torrenting</h1>
+ <h1>speedrr - Dynamic Upload Speed Manager for Torrenting</h1>
 </p>
 
 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 <a href="https://raw.githubusercontent.com/itschasa/speedrr/main/speedrr-unraid.xml">speedrr-unraid.xml</a>, 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 <a href="https://github.com/itschasa/speedrr/blob/main/config.yaml">template</a>, 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).

speedrr-unraid.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<Container version="2">
+ <Name>speedrr</Name>
+ <Repository>itschasa/speedrr</Repository>
+ <Registry>https://registry.hub.docker.com/r/itschasa/speedrr/</Registry>
+ <Network>host</Network>
+ <MyIP/>
+ <Shell>sh</Shell>
+ <Privileged>false</Privileged>
+ <Project>https://github.com/itschasa/speedrr</Project>
+ <Overview>
+ 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.
+ </Overview>
+ <Category>Tools:Utilities MediaApp:Other MediaApp:Video MediaServer:Video</Category>
+ <WebUI/>
+ <TemplateURL>https://raw.githubusercontent.com/itschasa/speedrr/master/speedrr-unraid.xml</TemplateURL>
+ <Icon>https://raw.githubusercontent.com/itschasa/speedrr/master/images/speedrr.png</Icon>
+ <ExtraParams/>
+ <PostArgs/>
+ <CPUset/>
+ <Requires/>
+ <Config Name="Config Folder" Target="/data" Default="/mnt/user/appdata/speedrr" Mode="rw" Description="" Type="Path" Display="always" Required="true" Mask="false"/>
+ <Config Name="SPEEDRR_CONFIG" Target="SPEEDRR_CONFIG" Default="/data/config.yaml" Mode="" Description="" Type="Variable" Display="always" Required="true" Mask="false"/>
+ <Config Name="SPEEDRR_LOG_LEVEL" Target="SPEEDRR_LOG_LEVEL" Default="20" Mode="" Description="" Type="Variable" Display="always" Required="false" Mask="false"/>
+ <Config Name="SPEEDRR_LOG_FILE_LEVEL" Target="SPEEDRR_LOG_FILE_LEVEL" Default="30" Mode="" Description="" Type="Variable" Display="always" Required="false" Mask="false"/>
+</Container>