ZeroTier Docker for unRaid

Description

Zerotier is an open source, cross-platform and easy to setup and use virtual LAN / Hamachi alternative available on Android, iOS, Mac, Windows, Linux.

Usage

This Dockerfile is pushed to dockerhub.

Also, it can be deployed in unRaid using a template.

The template is also published in unRaid "Community Applications" store.

Support and bug reports

This docker has a support thread on unRaid forum. It also includes step-by-step setup instructions.

Setup

Network and the docker image setup steps:

1. Create a https://my.zerotier.com/ account and create a Network there.
2. Ensure that "Managed Routes" section of your network settings DOESN'T include the subnet of IPs that is used in your local networks. You can check FAQ at the end of the post for more information.
3. Get an ID of the created network (looks something like b4da7454b271902c).
4. Install this docker image on your unRaid using a template. or from Community Applications and put that ID as a NETWORK_ID parameter of the container. Start the container.
5. Go to "Settings -> Network Settings -> Routing Table" and find the name of your zerotier gateway. It will have "zt*[0-9]" format, like "ztyouzqvq5".
6. Go to "Settings -> Network Settings -> Interface Extra" and add zerotier gateway name to "Include listening interfaces".
7. Go to https://my.zerotier.com/network/ and check “Auth” checkbox in “Members section” for the new device. Assign a meaningful name, copy an ip from "Managed IPs" column - it will be a static IP of your NAS in your virtual network.
8. Install a Zerotier client to your laptop/phone/other devices, join a network with the same id and repeat the previous step for them.
9. IP addresses that you found on the step 7 can be used to remotely access corresponding hosts from other devices connected to your virtual Zerotier network.

Now, when you connect Zerotier on any of your devices - a VPN connection will be set up and all connected devices will be available like they are in the same network. SMB shares/TimeMachine will be autodetected and available like you are in the same network, all UIs will be available on <ip from the step 4>:<usual port>.

Unraid 6.12+

If you would like to access local system services of Unraid (e.g. ssh or webgui) you must ensure the Zerotier interface is added as a listering interface. To do this go to Settings -> Network Settings in Unraid. Copy the interface name corresponding to Zerotier from the Routing Table. The interface usually has a prefix 'zt'. Afterwards paste the interface name into "Include listening interfaces" field under Interface Extra section, and hit apply.

Note: After a reboot you will need to manually re-apply the setting in order for this to take effect. I.e. copy/paste and hit apply. This is despite the interface appearing as included. It appears to be a bug on Unraid, last tested on Unraid version 6.12.6.

Kudos to user Vivent who originally reported this solution.