Skip to main content
Mole presenting

Getting Started

Welcome to Muti Metroo! This guide will help you get up and running with your first mesh network.

Prerequisites​

Before you begin, ensure you have:

  • Go 1.23 or later (for building from source)
  • Git (for cloning the repository)
  • Make (optional, for convenience commands)
  • Basic networking knowledge (understanding of TCP/IP, CIDR notation)

Choose Your Path​

Depending on your goals, choose the best starting point:

Quick Evaluation​

Want to quickly try Muti Metroo? Use the Interactive Setup Wizard:

# Build and run the wizard
make build
muti-metroo setup

The wizard guides you through all configuration steps with sensible defaults.

Time: 5-10 minutes

Go to Interactive Setup

Manual Configuration​

Need full control over your configuration? Follow the Quick Start Guide:

# Initialize agent and create config manually
muti-metroo init -d ./data
# Edit config.yaml
muti-metroo run -c ./config.yaml

Time: 15-30 minutes

Go to Quick Start

Docker Development​

Using Docker for development or testing? Start with Docker Compose:

# Start a 3-agent test mesh
docker compose build
docker compose up -d agent1 agent2 agent3

Time: 5 minutes

Go to Docker Setup

What You Will Learn​

By the end of the Getting Started guides, you will:

  1. Have Muti Metroo installed and running
  2. Understand the basic agent roles (ingress, transit, exit)
  3. Have generated TLS certificates for secure communication
  4. Created a basic configuration file
  5. Connected two or more agents into a mesh
  6. Successfully proxied traffic through your mesh

Next Steps​

  1. Installation - Build from source or use Docker
  2. Quick Start - Manual configuration walkthrough
  3. Interactive Setup - Guided wizard
  4. Your First Mesh - Connect multiple agents

Need Help?​