zetamesh

README

What is Zetamesh

Zetamesh /zeta'meʃ/ is used to build a security layer-three local area network on the WAN.

Quick Start

Prerequisites

• Golang 1.15 or newer
• Protoc 3.x & Protoc-gen-go

Instructions

This section will give you some instructions to make you quick start with Zetamesh.

• Build the zetamesh

  $ make
  

• Run a gateway at your VPS

  $ bin/zetagateway -k myprivate
  

• Run the zetamesh peer node

  • Peer Node 1

    $ sudo bin/zetamesh join --address 10.0.0.100 --gateway ${gateway}:2823 -k myprivate
    

  • Peer Node 2 (use DHCP if --address not present)

    $ sudo bin/zetamesh join --gateway ${gateway}:2823 -k myprivate
    

• Test your LAN (at the peer node 2)

  $ ping 10.0.0.100
  PING 10.0.0.100 (10.0.0.100): 56 data bytes
  Request timeout for icmp_seq 0
  64 bytes from 10.0.0.100: icmp_seq=1 ttl=64 time=17.239 ms
  64 bytes from 10.0.0.100: icmp_seq=2 ttl=64 time=15.449 ms
  64 bytes from 10.0.0.100: icmp_seq=3 ttl=64 time=14.627 ms
  64 bytes from 10.0.0.100: icmp_seq=4 ttl=64 time=15.418 ms
  

Usage

See: Command line documentation

Features

• Support P2P communication
• Support relay via Gateway when symmetric NAT exists
• Support traffic encryption between peers
• Support more operating systems
  • Support macOS
  • Support Linux
  • Support Windows
  • Support iOS
  • Support Android

Contribution

This project is in the early stage and many features on the roadmap. Welcome to file an issue or submit a PR.

References:

• Contributing guide.
• Code of conduct