Skip to content

Quick Start Guide

Get MarchProxy up and running in minutes with Docker Compose.

Prerequisites

  • Linux kernel 4.18+ (for eBPF support)
  • Docker and Docker Compose installed
  • 2+ CPU cores, 4GB+ RAM
  • Outbound internet connectivity

Installation Steps

1. Clone the Repository

git clone https://github.com/penguintechinc/marchproxy.git
cd marchproxy

2. Configure Environment

# Copy the example environment file
cp .env.example .env

# Edit configuration (optional for quick start)
nano .env

3. Start Services

# Start all services in background
docker-compose up -d

# Monitor startup logs
docker-compose logs -f

4. Verify Installation

Check that all services are running:

docker-compose ps

Expected output: 

NAME                COMMAND                SERVICE             STATUS              PORTS
marchproxy-manager  "python3 -m py4web …"  manager             running             0.0.0.0:8000->8000/tcp
marchproxy-proxy    "./proxy"              proxy               running
marchproxy-db       "docker-entrypoint.s…"  postgres            running             5432/tcp
marchproxy-grafana  "/run.sh"              grafana             running             0.0.0.0:3000->3000/tcp
marchproxy-prometheus "/bin/prometheus --c…" prometheus         running             0.0.0.0:9090->9090/tcp

5. Access Web Interface

6. Initial Configuration

  1. Login to Manager Portal:
  2. Default admin user: [email protected]
  3. Default password: admin123

  4. Change password immediately after first login

  5. Create Your First Service:

  6. Navigate to "Services" → "Add Service"
  7. Configure service-to-internet mapping
  8. Deploy configuration to proxies

Next Steps

Troubleshooting

Common Issues

  1. Port conflicts: Ensure ports 8000, 3000, 9090 are available
  2. Permission denied: Run with sudo if needed for Docker
  3. eBPF not supported: Check kernel version with uname -r

Getting Help