Installation

Installation Methods

1. Download Precompiled Binaries (Recommended)

   Visit the ⬇️Download Page to download the binaries or installation packages for your operating system.

2. Install via crates.io

   cargo install easytier

3. DockerHub

   DockerHub Image

   docker pull easytier/easytier:latest

4. Install via Docker Compose

   docker-compose.yml

   services:
     watchtower: # Used to automatically update the easytier image, delete this part if not needed
       image: containrrr/watchtower
       container_name: watchtower
       restart: unless-stopped
       environment:
         - TZ=Asia/Shanghai
         - WATCHTOWER_NO_STARTUP_MESSAGE
       volumes:
         - /var/run/docker.sock:/var/run/docker.sock
       command: --interval 3600 --cleanup --label-enable
     easytier:
       image: easytier/easytier:latest
       hostname: easytier
       container_name: easytier
       labels:
         com.centurylinklabs.watchtower.enable: 'true'
       restart: unless-stopped
       network_mode: host
       cap_add:
         - NET_ADMIN
         - NET_RAW
       environment:
         - TZ=Asia/Shanghai
       devices:
         - /dev/net/tun:/dev/net/tun
       volumes:
         - /etc/machine-id:/etc/machine-id:ro # Pass the host's machine id into container
         - /etc/easytier:/root
       command: -i <ip> --network-name <user> --network-secret <password> -p tcp://<server_address>:11010

5. One-Click Installation Script (Linux Only)

   wget -O /tmp/easytier.sh "https://raw.githubusercontent.com/EasyTier/EasyTier/main/script/install.sh" && bash /tmp/easytier.sh install

6. Install from Source

   cargo install --git https://github.com/EasyTier/EasyTier.git easytier

Third-Party Tools

• EasyTier Game (Windows)
• EasyTier Manager (Windows)
• luci-app-easytier (OpenWrt)

FAQ

Question 1

Q: Unable to create a network on Windows 7, the program crashes or reports an error that it cannot create a virtual network.

A: Windows 7 requires SP1 or above, and the installation of KB3063858 and KB4474419 patches.

Question 2

Q: The Linux command line help is in English, how to change it to Chinese?

A: You need to set the environment variable LANG=zh_CN, command: export LANG=zh_CN

Question 3

Q: TunError is prompted after startup.

A: Ensure that the TUN driver is correctly loaded and the /dev/net/tun file exists. If using Docker, make sure to enable privileged mode. The method to load the Linux TUN driver is:

modprobe tun
mkdir /dev/net
sudo mknod /dev/net/tun c 10 200