https://github.com/samvrlewis/meshboi
meshboi is a mesh VPN tool created for the purposes of learning and fun
https://github.com/samvrlewis/meshboi
mesh-networking mesh-vpn networking vpn
Last synced: 12 days ago
JSON representation
meshboi is a mesh VPN tool created for the purposes of learning and fun
- Host: GitHub
- URL: https://github.com/samvrlewis/meshboi
- Owner: samvrlewis
- License: mit
- Created: 2021-03-03T05:44:22.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-25T02:19:26.000Z (about 2 years ago)
- Last Synced: 2024-11-09T17:42:52.854Z (6 months ago)
- Topics: mesh-networking, mesh-vpn, networking, vpn
- Language: Go
- Homepage: https://www.samlewis.me/2021/07/creating-mesh-vpn-tool-for-fun/
- Size: 89.8 KB
- Stars: 127
- Watchers: 7
- Forks: 18
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-repositories - samvrlewis/meshboi - meshboi is a mesh VPN tool created for the purposes of learning and fun (Go)
README
#  meshboi
meshboi is a toy mesh VPN implementation, created for fun and learning purposes. It allows the creation of peer to peer networks over the internet in a similar fashion to tools such as [Nebula](https://github.com/slackhq/nebula) and [Tailscale](https://tailscale.com/).
More information about how meshboi works is available on my blog post [Creating a mesh VPN tool for fun and learning](https://www.samlewis.me/2021/07/creating-mesh-vpn-tool-for-fun/).
## Quick Start
1. Download the most recent [release](https://github.com/samvrlewis/meshboi/releases).
2. Start meshboi on one host:
```
./meshboi client -rolodex-address rolodex.samlewis.me -vpn-ip 192.168.50.1/24 -psk -network
```
3. Start meshboi on another host:
```
./meshboi client -rolodex-address rolodex.samlewis.me -vpn-ip 192.168.50.2/24 -psk -network
```
4. The hosts should now be able to communicate as though they were on the same LAN!
Note that this will use the publicly accessible rolodex server that I host. No user data flows through this server other than metadata that contains the internet IP and ports of your instances (though this has not been properly audited, so please use at your own risk!). You are also free to host your own Rolodex server on an an internet accessible server (a cheap EC2 instance or equivalent will work fine). You can do so with:
```
./meshboi rolodex
```
And then use the IP address or hostname of this server when starting meshboi in client mode (with the `-rolodex-address` option).
## Demo
An asciinema recording of meshboi in action:
[](https://asciinema.org/a/Cux2gxc8VusS0QbL3tkmWLFb4)