Readme standartization.

This commit is contained in:
2025-08-23 23:35:06 +02:00
parent 2bb9e2541a
commit 75917f8828
20 changed files with 284 additions and 149 deletions

View File

@@ -1,4 +1,16 @@
Please read the documentation first!
https://haugene.github.io/docker-transmission-openvpn/
Compose file is set to use NordVPN, change the provider if needed and also comment out NordVPN country variable.
# Transmission with OpenVPN (haugene/transmission-openvpn)
This directory contains the configuration for the `haugene/transmission-openvpn` Docker image. This image bundles the Transmission BitTorrent client with an OpenVPN client, which ensures that all of Transmission's traffic is routed through a VPN tunnel, enhancing privacy and security.
[GitHub Repository](https://github.com/haugene/docker-transmission-openvpn)
## How to start
1. Create a `.env` file based on the `.env.example` file.
2. Set the environment variables in the `.env` file, including your VPN provider and credentials.
3. Run `docker-compose up -d` to start the application.
4. The Transmission web interface will be available at [http://localhost:9091](http://localhost:9091).
## Setup
After starting the application, you can access the Transmission web interface to manage your torrents. The OpenVPN client will automatically connect to your VPN provider.

View File

@@ -0,0 +1,16 @@
# Transmission (lscr.io/linuxserver/transmission)
This directory contains the configuration for the `lscr.io/linuxserver/transmission` Docker image. This image provides the Transmission BitTorrent client.
[LinuxServer.io Website](https://www.linuxserver.io/)
## How to start
1. Create a `.env` file based on the `.env.example` file.
2. Set the environment variables in the `.env` file.
3. Run `docker-compose up -d` to start the application.
4. The Transmission web interface will be available at [http://localhost:9091](http://localhost:9091).
## Setup
After starting the application, you can access the Transmission web interface to manage your torrents.