Portainer Templates logo

Portainer Templates

Deluge openvpn

Container

OtherVPNTools

This container contains OpenVPN and Deluge with a configuration where Deluge is running only when OpenVPN has an active tunnel. It bundles configuration files for many popular VPN providers to make the setup easier.

Image details

Pulls: 2.4M
Architecture: amd64, arm64, arm
Image size: 123 MB
User: sgtsquiggs
Created: Jan 20, 2019
Updated: 5 years ago
Status: active

Configuration

Type
Container
Platform
linux
Image
sgtsquiggs/deluge-openvpn:latest
Ports
8112:8112/tcp
Volumes
/etc/localtime : /etc/localtime/downloads : /portainer/Downloads/config : /portainer/Files/AppData/Config/DelugeOpenVPN/config
Env vars
PUID=1001PUID=1001OPENVPN_PROVIDER=MULLVADOPENVPN_USERNAME=''OPENVPN_PASSWORD=''
Restart
unless-stopped

Template by SelfhostedPro

Standalone Install

Select an install method, to see config/commands for deploying Deluge openvpn

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Deluge openvpn, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

This container is no longer actively maintained. Several features in the old README never worked. If you'd like to take over, please open an issue on the GitHub repo: https://github.com/sgtsquiggs/docker-deluge-openvpn

Serve Deluge openvpn on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying deluge-openvpn.example.com to http://deluge-openvpn:8112

Add this to your Caddyfile

deluge-openvpn.example.com {
	reverse_proxy http://deluge-openvpn:8112
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs deluge-openvpn
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8112 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8112
  • Stop the other service, or pick a different host port. In 8112:8112 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8112. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, deluge-openvpn can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8112

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1001:1000 /etc/localtime (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 1001:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull sgtsquiggs/deluge-openvpn:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect deluge-openvpn --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

OPENVPN_USERNAME, OPENVPN_PASSWORD have no default value, and deluge-openvpn may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Deluge openvpn runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Deluge openvpn needs bundled into one download. This template pulls sgtsquiggs/deluge-openvpn:latest, which Docker fetches once (about 123 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Deluge openvpn's comes from Docker Hub, published by sgtsquiggs.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8112:8112 means it's reachable on port 8112 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 8112:8112

Volumes

A volume is where Deluge openvpn keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /etc/localtime from /etc/localtime on the host
  • /downloads from /portainer/Downloads on the host
  • /config from /portainer/Files/AppData/Config/DelugeOpenVPN/config on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Deluge openvpn takes 4 of them, and 2 need a value before it'll start properly:

  • PUID, defaults to 1001. PGID
  • OPENVPN_PROVIDER, defaults to MULLVAD. See https://github.com/sgtsquiggs/docker-deluge-openvpn
  • OPENVPN_USERNAME, needs a value
  • OPENVPN_PASSWORD, needs a value

Restart policy

The restart policy here is unless-stopped, so Docker restarts Deluge openvpn after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Deluge openvpn sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container deluge-openvpn. That's what you'll spot in the containers list and use in commands like docker logs deluge-openvpn.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Deluge openvpn up. Add the template list to Portainer once, then deploying Deluge openvpn is a click rather than a wall of config.