From 06c879288758868359c3a3b7945675499a6d6548 Mon Sep 17 00:00:00 2001 From: "Quentin McGaw (desktop)" Date: Tue, 22 Jun 2021 15:21:49 +0000 Subject: [PATCH] Doc: clarify setup instructions --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b382ee81..c1b7f5a8 100644 --- a/README.md +++ b/README.md @@ -58,9 +58,17 @@ using Go, OpenVPN, iptables, DNS over TLS, ShadowSocks and an HTTP proxy* ## Setup -1. On some devices you may need to setup your tunnel kernel module on your host with `insmod /lib/modules/tun.ko` or `modprobe tun` - - [Synology users Wiki page](https://github.com/qdm12/gluetun/wiki/Synology-setup) -1. ⚠️ Raspberry Pi users running 32 bit systems: from image `v3.16.0` you need to do [this](https://github.com/alpinelinux/docker-alpine/issues/135#issuecomment-812287338) on your host to run the container. +1. Ensure your `tun` kernel module is setup: + + ```sh + sudo modprobe tun + # or, if you don't have modprobe, with + sudo insmod /lib/modules/tun.ko + ``` + +1. Extra steps: + - [For Synology users](https://github.com/qdm12/gluetun/wiki/Synology-setup) + - [For 32 bit Operating systems (**Rasberry Pis**)](https://github.com/qdm12/gluetun/wiki/32-bit-setup) 1. Launch the container with: ```bash