Skip to main content
Mole building

Installation

This guide covers all methods for installing Muti Metroo.

Download Binary​

The easiest way to install Muti Metroo is to download a pre-built binary for your platform.

Download Muti Metroo

Pre-built binaries are available for:

  • macOS: Apple Silicon (arm64) and Intel (amd64) - both installer packages and standalone binaries
  • Linux: x86_64 (amd64) and ARM64 (aarch64)
  • Windows: x86_64 (amd64) and ARM64

Quick Install (Linux/macOS)​

# Download for your platform (example: Linux amd64)
curl -L -o muti-metroo https://muti-metroo.postalsys.ee/downloads/latest/muti-metroo-linux-amd64

# Make executable and install
chmod +x muti-metroo
sudo mv muti-metroo /usr/local/bin/

# Verify installation
muti-metroo --version

See the Download page for platform-specific instructions.

Docker Installation​

Build Docker Image​

# Build the image
docker build -t muti-metroo .

# Or use Docker Compose
docker compose build

Run with Docker​

docker run -d --name muti-metroo \
  -v $(pwd)/config.yaml:/app/config.yaml \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/certs:/app/certs \
  -p 1080:1080 \
  -p 4433:4433/udp \
  -p 8080:8080 \
  muti-metroo

Docker Compose​

See Docker Deployment for complete Docker Compose setup.

System Service Installation​

Install Muti Metroo as a system service for automatic startup.

Linux (systemd)​

# Install as service (requires root)
sudo muti-metroo service install -c /etc/muti-metroo/config.yaml

# Enable and start
sudo systemctl enable muti-metroo
sudo systemctl start muti-metroo

# Check status
sudo systemctl status muti-metroo

# View logs
sudo journalctl -u muti-metroo -f

Windows​

# Install as Windows Service (requires Administrator)
muti-metroo.exe service install -c C:\ProgramData\muti-metroo\config.yaml

# Start service
sc start muti-metroo

# Check status
sc query muti-metroo

Uninstall Service​

# Linux
sudo muti-metroo service uninstall

# Windows (as Administrator)
muti-metroo.exe service uninstall

Directory Structure​

After installation, you will typically have:

/etc/muti-metroo/          # Configuration (Linux)
  config.yaml              # Main configuration file
/var/lib/muti-metroo/      # Data directory (Linux)
  agent_id                 # Agent identity file
  control.sock             # Control socket
/var/log/muti-metroo/      # Logs (if using file logging)

For development:

./config.yaml              # Configuration file
./data/                    # Data directory
  agent_id                 # Agent identity
  control.sock             # Control socket
./certs/                   # TLS certificates
  ca.crt                   # Certificate Authority
  agent.crt                # Agent certificate
  agent.key                # Agent private key

Verify Installation​

After installation, verify everything works:

# Initialize agent identity
muti-metroo init -d ./data

# Check the generated agent ID
cat ./data/agent_id

# Generate test certificates
muti-metroo cert ca -n "Test CA"
muti-metroo cert agent -n "test-agent"

# Verify certificates
muti-metroo cert info ./certs/agent.crt

Next Steps​