rutorrent: update README.md

rutorrent/README.md

@@ -1,61 +1,60 @@
-# RuTorrent Image
+## wonderfall/rutorrent
+Originally forked from [xataz/rutorrent](https://github.com/xataz/dockerfiles/tree/master/rutorrent).
 
-## ImageLayer
+#### What is this?
-* latest [![](https://badge.imagelayers.io/xataz/rutorrent:latest.svg)](https://imagelayers.io/?images=xataz/rutorrent:latest 'Get your own badge on imagelayers.io')
+This container contains both rtorrent (whis is a BitTorrent client) and rutorrent (which is a front-end for rtorrent). Filebolt is also included, the default behavior is set to create clean symlinks, so media players like Emby/Plex can easily detect your TV shows and movies.
-* latest-filebot, filebot [![](https://badge.imagelayers.io/xataz/rutorrent:filebot.svg)](https://imagelayers.io/?images=xataz/rutorrent:filebot 'Get your own badge on imagelayers.io')
 
-## Tag available
-* latest [(rutorrent/latest/Dockerfile)](https://github.com/xataz/dockerfiles/blob/master/rutorrent/latest/Dockerfile)
-* latest-filebot, filebot [(rutorrent/latest-filebot/Dockerfile)](https://github.com/xataz/dockerfiles/blob/master/rutorrent/latest-filebot/Dockerfile)
 
-## Description
+#### Main features
-What is [RuTorrent](https://github.com/Novik/ruTorrent) ?
+- Lightweight, since it's based on Alpine Linux.
+- Everything is almost compiled from source.
+- Secured, don't bother about configuration files.
+- Filebot is included, and creates symlinks in /data/Media.
+- FlatUI themes for rutorrent are included.
 
-ruTorrent is a front-end for the popular Bittorrent client rtorrent.
+#### Ports
-This project is released under the GPLv3 license, for more details, take a look at the LICENSE.md file in the source.
+There's one port to bind to your host (both tcp/udp) : 49184 (arbitrary chosen).
 
-What is [rtorrent](https://github.com/rakshasa/rtorrent/) ?
+#### Volumes
+- **/data** : your files, symlinks, etc. everything you must care of.
+- **/var/www/torrent/share/users** : rutorrent settings, as you don't want them to go away each time you update the container.
 
-rtorrent is the popular Bittorrent client.
+#### How to use it?
+Basically you just have to run the container behind a reverse proxy.
+This may help you : https://hub.docker.com/r/wonderfall/reverse/
 
-## BUILD IMAGE
+Here is an example of a docker-compose.yml file :
 
-```shell
-docker build -t xataz/rutorrent github.com/xataz/dockerfiles.git#master:rutorrent/latest
 ```
-
+nginx:
-## Configuration
+  image: wonderfall/reverse:1.9
-### Environments
+  container_name: nginx
-* UID : Choose uid for launch rtorrent (default : 991)
+  environment:
-* GID : Choose gid for launch rtorrent (default : 991)
+    - UID=1000
-* WEBROOT : (default : /)
+    - GID=1000
-
+  ports:
-### Volumes
+    - "80:8000"
-* /data : Folder for download torrents
+    - "443:4430"
-
+  links:
-#### data Folder tree
+    - rutorrent:rutorrent
-* /data/.watch : Rtorrent watch this folder and add automatly torrent file
+  volumes:
-* /data/.session : Rtorrent save statement here
+    - /home/docker/nginx/sites:/sites-enabled
-* /data/torrents : Rtorrent download torrent here
+    - /home/docker/nginx/conf:/conf.d
-* /data/Media : If filebot version, rtorrent create a symlink 
+    - /home/docker/nginx/passwds:/passwds
-
+    - /home/docker/nginx/log:/var/log/nginx
-### Ports
+    - /home/docker/nginx/certs:/certs
-* 80
+    
-
+rutorrent:
-## Usage
+  image: wonderfall/rutorrent
-### Simple launch
+  container_name: rutorrent
-```shell
+  environment:
-docker run -d -p 80:80 xataz/rutorrent
+    - WEBROOT=/
+    - UID=1000
+    - GID=1000
+  ports:
+    - "49184:49184"
+    - "49184:49184/udp"
+  volumes:
+    - /home/user/seedbox:/data
+    - /home/user/seedbox/rutorrent:/var/www/torrent/share/users
 ```
-URI access : http://XX.XX.XX.XX
-
-### Advanced launch
-```shell
-docker run -d -p 80:80 \
-	-v /docker/data:/data \ 
-	-e UID=1001 \
-	-e GID=1001 \
-    -e WEBROOT=/rutorrent \
-	xataz/rutorrent:filebot
-```
-URI access : http://XX.XX.XX.XX/rutorrent