Skip to content
Mend Media Engine

Quick Start Guide

Get up and running with Mend Media Processing Engine in 5 minutes!

Prerequisites

Section titled “Prerequisites”

Before you begin, make sure you have the following installed:

S3 Storage

AWS S3 or compatible service (MinIO, R2)

Installation

Section titled “Installation”

  1. Install Go (if not already installed)

    Follow the instructions on the Go website to install Go.

    Terminal window
    go version  # Verify installation

  2. Install Redis or configure an existing Redis instance

    Follow the instructions on the Redis website to install Redis.

  3. Configure the Application

    Terminal window
    cd /Users/[your-username]/Developer/mend
    

    # Copy configuration files
    cp config.example.yaml config.yaml
    cp .env.example .env
    

    # Edit .env with your AWS credentials
    nano .env

    Add your AWS credentials to .env:

    .env
    AWS_ACCESS_KEY_ID=your_access_key_id
    AWS_SECRET_ACCESS_KEY=your_secret_access_key
    AWS_REGION=us-east-1

  4. Download Dependencies

    Terminal window
    go mod download

  5. Run the Application

    Open two terminal windows:

    Terminal window
    go run cmd/api/main.go

Test It Out

Section titled “Test It Out”

Check Health

Section titled “Check Health”

Verify the API is running:

Terminal window
curl http://localhost:8080/health

View API Documentation

Section titled “View API Documentation”

Open in your browser:

http://localhost:8080/swagger/index.html

Process an Image

Section titled “Process an Image”

First, upload an image to your S3 bucket, then:

Terminal window
curl -X POST http://localhost:8080/api/v1/jobs/image/resize \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key_here" \
  -d '{
    "source_bucket": "your-bucket-name",
    "source_key": "path/to/image.jpg",
    "dest_bucket": "your-bucket-name",
    "dest_key": "path/to/resized.jpg",
    "width": 800,
    "height": 600
  }'

You’ll get a response with a job ID:

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "pending",
  "message": "Job queued for processing"
}

Using Docker (Alternative)

Section titled “Using Docker (Alternative)”
Terminal window
# Start all services
docker-compose up -d


# View logs
docker-compose logs -f


# Access MinIO console for local S3
open http://localhost:9001
# Login: minioadmin / minioadmin

Available Operations

Section titled “Available Operations”

Image Resize

Resize images to specific dimensions

Image Optimize

Compress and convert to WebP/AVIF

Video Thumbnails

Extract frames from videos

Audio Conversion

Convert between audio formats

AI Analysis

Send to AI services for analysis

Common Issues

Section titled “Common Issues”

”command not found: go"

Section titled “”command not found: go"”
Terminal window
brew install go

"connection refused” to Redis

Section titled “"connection refused” to Redis”
Terminal window
brew services start redis

S3 access denied

Section titled “S3 access denied”

Check your AWS credentials in .env file

Port 8080 already in use

Section titled “Port 8080 already in use”

Change port in config.yaml:

config.yaml
server:
  port: 8081

What’s Next?

Section titled “What’s Next?”

Read the API Docs

Learn about all available endpoints in the API Reference

Set Up Authentication

Secure your API with API keys