Skip to main content
Mole presenting

Getting Started

In the next few minutes, you will have a working tunnel that can reach networks behind firewalls, relay traffic through multiple hops, and route connections to any destination.

Try It in 2 Minutes​

No installation needed - just Docker:

git clone https://github.com/postalsys/Muti-Metroo.git
cd Muti-Metroo/examples/docker-tryout
docker compose up -d

That's it! You now have a working 4-agent mesh:

  • Dashboard API: curl http://localhost:18080/api/dashboard | jq
  • Test proxy: curl -x socks5h://localhost:11080 https://httpbin.org/ip

Query the dashboard API to see how agents connect through the mesh, then continue below for production setup.

Production Setup​

What you will build:

  • A SOCKS5 proxy that tunnels traffic through restricted networks
  • Multi-hop relay chains that reach destinations you could not access directly
  • Exit points that connect to internal resources or the internet
Transparent Routing with TUN Interface

Want to route all traffic through the mesh without configuring each application for SOCKS5? On Linux, you can use Mutiauk - a companion TUN interface that transparently intercepts Layer 3 traffic and forwards it through Muti Metroo.

Prerequisites​

Choose Your Path​

PathBest ForTime
Interactive SetupNew users, guided experience5-10 min
Quick StartManual control, scripting10-15 min
DockerContainerized deployments5 min

The wizard handles everything - certificates, identity, and configuration:

muti-metroo setup

Go to Interactive Setup

Alternative: Manual Configuration​

For full control or automation:

muti-metroo init -d ./data
# Create config.yaml (see Quick Start)
muti-metroo run -c ./config.yaml

Go to Quick Start

Next Steps​

After setup, explore:

Need Help?​