Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Fullaxx committed Mar 15, 2019
1 parent 14f4f05 commit 5ede4ce
Showing 1 changed file with 34 additions and 33 deletions.
67 changes: 34 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,47 +4,48 @@
Ubuntu 18.04 (x64)

## Get the image from Docker Hub

docker pull fullaxx/rtorrent-openvpn

```
docker pull fullaxx/rtorrent-openvpn
```
## Required Volume Options
Input: Drop your torrents in /srv/docker/rtorrent/autoload/

-v /srv/docker/rtorrent/autoload:/rtorrent/autoload

```
-v /srv/docker/rtorrent/autoload:/rtorrent/autoload
```
Output: Your downloaded data will reside here

-v /srv/docker/rtorrent/torrents:/rtorrent/torrents

```
-v /srv/docker/rtorrent/torrents:/rtorrent/torrents
```
## Optional Volume Options
Configuration: Any .ovpn files or a custom rtorrent.rc can be placed in /srv/docker/rtorrent/config/

-v /srv/docker/rtorrent/config:/rtorrent/config

```
-v /srv/docker/rtorrent/config:/rtorrent/config
```
Session State: Use this to save your session for fast restore/resume

-v /srv/docker/rtorrent/session:/rtorrent/session

```
-v /srv/docker/rtorrent/session:/rtorrent/session
```
## Run the image
Run the image using the default port without OpenVPN

docker run \
-v /srv/docker/rtorrent/autoload:/rtorrent/autoload \
-v /srv/docker/rtorrent/torrents:/rtorrent/torrents \
-it -p 49164:49164 fullaxx/rtorrent-openvpn

```
docker run \
-v /srv/docker/rtorrent/autoload:/rtorrent/autoload \
-v /srv/docker/rtorrent/torrents:/rtorrent/torrents \
-it -p 49164:49164 fullaxx/rtorrent-openvpn
```
Run the image using the default port with OpenVPN \
Make sure that your myconnection.ovpn exists in /srv/docker/rtorrent/config/

docker run --cap-add=NET_ADMIN --device /dev/net/tun \
-v /srv/docker/rtorrent/autoload:/rtorrent/autoload \
-v /srv/docker/rtorrent/torrents:/rtorrent/torrents \
-v /srv/docker/rtorrent/config:/rtorrent/config \
-v /srv/docker/rtorrent/session:/rtorrent/session \
-e OVPNCFG='myconnection.ovpn' \
-e OVPNSLEEPTIME='4' \
-it -p 49164:49164 fullaxx/rtorrent-openvpn

```
docker run --cap-add=NET_ADMIN --device /dev/net/tun \
-v /srv/docker/rtorrent/autoload:/rtorrent/autoload \
-v /srv/docker/rtorrent/torrents:/rtorrent/torrents \
-v /srv/docker/rtorrent/config:/rtorrent/config \
-v /srv/docker/rtorrent/session:/rtorrent/session \
-e OVPNCFG='myconnection.ovpn' \
-e OVPNSLEEPTIME='4' \
-it -p 49164:49164 fullaxx/rtorrent-openvpn
```
## Build it locally using the github repository

docker build -t="fullaxx/rtorrent-openvpn" github.com/fullaxx/rtorrent-openvpn
```
docker build -t="fullaxx/rtorrent-openvpn" github.com/fullaxx/rtorrent-openvpn
```

0 comments on commit 5ede4ce

Please sign in to comment.