From 35ca4ae051c9ddbf2e66c88d9c60810881ad7d88 Mon Sep 17 00:00:00 2001
From: tiyn <tiyn@mail-mk.eu>
Date: Mon, 21 Nov 2022 03:55:26 +0100
Subject: [PATCH] trms: added

---
 .../haugene_-_transmission-openvpn.md         | 70 +++++++++++++++++++
 wiki/transmission.md                          | 10 +++
 2 files changed, 80 insertions(+)
 create mode 100644 wiki/docker-images/haugene_-_transmission-openvpn.md
 create mode 100644 wiki/transmission.md

diff --git a/wiki/docker-images/haugene_-_transmission-openvpn.md b/wiki/docker-images/haugene_-_transmission-openvpn.md
new file mode 100644
index 0000000..557361e
--- /dev/null
+++ b/wiki/docker-images/haugene_-_transmission-openvpn.md
@@ -0,0 +1,70 @@
+# haugene - transmission-openvpn
+
+This is a docker container for a [transmission](../transmission.md) server that
+is connected to the internet via an openVPN tunnel.
+The official container and documentation was made by
+[haugene](https://github.com/haugene/docker-transmission-openvpn).
+
+## Set-up
+
+Create the file `rebuild.sh`.
+To see which providers are supported take a look at the
+[official documentation](https://haugene.github.io/docker-transmission-openvpn/supported-providers/).
+Change the settings according to your needs and run `./rebuild.sh` afterwards.
+
+## Environment-variables
+
+Set the following variables with the -e tag.
+
+| Name                | Usage                       | Default |
+| ------------------- | --------------------------- | ------- |
+| `OPENVPN_PROVIDER`  | Provider for OpenVPN        | ` `     |
+| `OPENVPN_USERNAME`  | Username for OpenVPN        | ` `     |
+| `OPENVPN_PASSWORD`  | Password for OpenVPN        | ` `     |
+| `LOCAL_NETWORK`     | Subnet of the local network | ` `     |
+| `CREATE_TUN_DEVICE` | Use a tunnel device         | ` `     |
+| `WEBPROXY_ENABLES`  | Use a webproxy              | ` `     |
+
+## Volumes
+
+Set the following volumes with the -v tag.
+
+| Outside mount/volume name | Container mount | Description             |
+| ------------------------- | --------------- | ----------------------- |
+| `transmission_config`     | `/config`           | Configuration files     |
+| `transmission data`       | `/data`         | Storage for data        |
+| `/etc/localtime`          | `/etc/localtime:ro` | Link to the systemtime  |
+
+## Ports
+
+Set the following ports with the -p tag.
+
+| Container Port | Recommended outside port | Protocol | Description |
+| -------------- | ------------------------ | -------- | ----------- |
+| `9091`         | `9091`                   | TCP      | WebUI       |
+
+## rebuild.sh
+
+```sh
+#!/bin/sh
+docker stop transmission
+docker rm transmission
+docker pull haugene/transmission-openvpn
+docker run --name transmission \
+        --restart unless-stopped \
+        --cap-add NET_ADMIN \
+        -v /etc/localtime:/etc/localtime:ro \
+        -v transmission_data:/data \
+        -v transmission_config:/config \
+        -e OPENVPN_PROVIDER=vpn \
+        -e OPENVPN_CONFIG=vpn-country-udp \
+        -e OPENVPN_USERNAME=username \
+        -e OPENVPN_PASSWORD=password \
+        -e LOCAL_NETWORK=192.168.178.0/24 \
+        -e CREATE_TUN_DEVICE=true \
+        -e WEBPROXY_ENABLES=false \
+        --log-driver json-file \
+        --log-opt max-size=50m \
+        -p 9091:9091 \
+        -d haugene/transmission-openvpn
+```
diff --git a/wiki/transmission.md b/wiki/transmission.md
new file mode 100644
index 0000000..b3fea25
--- /dev/null
+++ b/wiki/transmission.md
@@ -0,0 +1,10 @@
+# Transmission
+
+[Transmission](https://transmissionbt.com/) is a free and cross-platform
+BitTorrent client.
+
+## Setup
+
+The software can be setup via docker with the
+[haugene image](./docker-images/haugene_-_transmission-openvpn.md) that
+includes an openvpn tunnel.