Difference between revisions of "OpenVPN server in Linux Containers"

From ArchWiki
Jump to: navigation, search
(autodev is not required)
(OpenVPN: add note to get openvpn to work)
Line 57: Line 57:
 
==== OpenVPN ====
 
==== OpenVPN ====
 
Refer to the [[OpenVPN]] article to properly setup the home server.  Verify openvpn functionality within the container; [[start]] openvpn via {{ic|openvpn@myprofile.service}} and once satisfied [[enable]] it to run at boot.
 
Refer to the [[OpenVPN]] article to properly setup the home server.  Verify openvpn functionality within the container; [[start]] openvpn via {{ic|openvpn@myprofile.service}} and once satisfied [[enable]] it to run at boot.
 +
 +
{{Note|Users running openvpn within an ''unprivileged'' container will need to create a custom systemd unit to start it within the container.  Simply copy the package-provided {{ic|/usr/lib/systemd/system/openvpn-server@.service}} to {{ic|/etc/systemd/system/openvpn-server@.service}} and modify the new file commenting out the the line beginning with: {{ic|LimitNPROC...}}}}
  
 
==== ufw ====
 
==== ufw ====

Revision as of 07:42, 12 January 2017

This article describes how to setup a Linux Container to run OpenVPN in server mode for secure/private internet use. Doing so offers a distinct advantage over using full-blown virtualization like VirtualBox or QEMU in that the resource overhead is minimal by comparison and able to run on low powered devices.

Host setup

  1. The host OS needs a bridge ethernet setup to allow the container to run. Refer to Linux_Containers#Host_network_configuration for this.
  2. One needs to enable packet forwarding. Refer to Internet_sharing#Enable_packet_forwarding for this.
  3. Although not strictly required, a firewall is highly recommended.
Warning: On the ODROID series of hardware, users need to configure the default forward policy due to some quirkiness. This does not apply to other Arch ARM devices such as Raspberry Pis nor does it apply to x86_64 or i686 machines. For a work-around, see ODROID#DHCP_assignments_to_LXCs_do_not_work_as_expected for a work-around.

Container setup

Basic setup and understanding of Linux Containers is required. This article assumes that readers have a base LXC setup and operational. New comers to these are directed to the aforementioned article.

LXC config

The container's config should be modified to include several key sections in order run OpenVPN.

For the example, the lxc is named "playtime" and a full config is shown:

/var/lib/lxc/playtime/config
# Template used to create this container: /usr/share/lxc/templates/lxc-archlinux
# Parameters passed to the template:
# For additional config options, please look at lxc.container.conf(5)

lxc.rootfs = /var/lib/lxc/playtime/rootfs
lxc.utsname = playtime
lxc.arch = x86_64
lxc.include = /usr/share/lxc/config/archlinux.common.conf

## network
lxc.network.type = veth
lxc.network.link = br0
lxc.network.flags = up
lxc.network.name = eth0

## mounts
lxc.mount.entry = /var/cache/pacman/pkg var/cache/pacman/pkg none bind 0 0

## for openvpn
lxc.mount.entry = /dev/net dev/net none bind,create=dir
lxc.cgroup.devices.allow = c 10:200 rwm

Needed packages within the container

In addition to the base system, openvpn is required and available from the official repositories. A properly configured firewall to run within the container is highly recommended. This guide uses ufw which is very easy to configure, but other examples can certainly be used.

Package setup

OpenVPN

Refer to the OpenVPN article to properly setup the home server. Verify openvpn functionality within the container; start openvpn via openvpn@myprofile.service and once satisfied enable it to run at boot.

Note: Users running openvpn within an unprivileged container will need to create a custom systemd unit to start it within the container. Simply copy the package-provided /usr/lib/systemd/system/openvpn-server@.service to /etc/systemd/system/openvpn-server@.service and modify the new file commenting out the the line beginning with: LimitNPROC...

ufw

Refer to OpenVPN#Firewall configuration to setup the routes and firewall within the container. Failure to do so or to implement with an alternative will prevent openvpn from functioning properly in the container.

Start ufw and enable ufw.service to start at boot.

# ufw enable