easytier.github.io/en/guide/installation.md

Installation (Command Line Program)

This section only introduces installation methods. Please read the Quick Networking documentation to understand parameter meanings and usage methods.

Installation Methods

1. Manual Download of Command Line Program

   Visit the ⬇️Download Page to download the EasyTier command line program suitable for your operating system and hardware architecture. After downloading, it's a ZIP compressed package that can be used directly after extraction.

   ::: code-group

   ./easytier-core --version
   

   .\easytier-core.exe --version
   

   :::

   ---

2. DockerHub

   DockerHub Image Address

   # docker.io image
   docker pull easytier/easytier:latest
   docker run -d --privileged --network host easytier/easytier:latest
   
   # Domestic users can use DaoCloud image
   docker pull m.daocloud.io/docker.io/easytier/easytier:latest
   docker run -d --privileged --network host m.daocloud.io/docker.io/easytier/easytier:latest
   

   Please continue reading the Quick Networking documentation to understand parameter meanings and usage methods.

   ---

3. Install via Docker Compose

   ::: details docker-compose.yml

    services:
      # watchtower automatically updates the EasyTier image; remove this section if not needed
      watchtower:
        image: nickfedor/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:
        # Users in mainland China can use the DaoCloud mirror
        # image: m.daocloud.io/docker.io/easytier/easytier:latest
        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
        command: >
          -d --network-name <user> --network-secret <password>
          -p tcp://<public-ip-of-other-peer-or-public-node>:11010
   

   :::

   To separate the configuration file from the container, create a conf directory next to docker-compose.yml and save the EasyTier configuration file as ./conf/easytier.toml:

   ::: details docker-compose.yml (start with configuration file)

    services:
      easytier:
        # Users in mainland China can use the DaoCloud mirror
        # image: m.daocloud.io/docker.io/easytier/easytier:latest
        image: easytier/easytier:latest
        hostname: easytier
        container_name: easytier
        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
          - ./conf:/config
        command: >
          -c /config/easytier.toml
   

   :::

   After modifying ./conf/easytier.toml, run docker compose restart easytier to reload the configuration.

   ---

4. One-Click Installation Script (Linux Only)

   Note: The one-click script depends on unzip, please download and install it in advance.

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

   After the script executes successfully, EasyTier's binary programs will be installed in the /opt/easytier directory, and the configuration file is located at /opt/easytier/config/default.conf.

   EasyTier will be registered as a system service and can be managed with the following commands:

   systemctl start easytier@default
   

   ---

5. Install from Source

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

   Source installation requires Rust environment and LLVM installation.