server

Kernel Images Server

A REST API server to start, stop, and download screen recordings.

🛠️ Prerequisites

Required Software

• Go 1.24.3+ - Programming language runtime
• ffmpeg - Video recording engine
  • macOS: brew install ffmpeg
  • Linux: sudo apt install ffmpeg or sudo yum install ffmpeg
• pnpm - For OpenAPI code generation
  • npm install -g pnpm

System Requirements

• macOS: Uses AVFoundation for screen capture
• Linux: Uses X11 for screen capture
• Windows: Not currently supported

🚀 Quick Start

Running the Server

make dev

The server will start on port 10001 by default and log its configuration.

Example use

# 1. Start a new recording
curl http://localhost:10001/recording/start -d {}

# (recording in progress)

# 2. Stop recording
curl http://localhost:10001/recording/stop -d {}

# 3. Download the recorded file
curl http://localhost:10001/recording/download --output recording.mp4

⚙️ Configuration

Configure the server using environment variables:

Example Configuration

export PORT=8080
export FRAME_RATE=30
export MAX_SIZE_MB=1000
export OUTPUT_DIR=/tmp/recordings
./bin/api

API Documentation

• YAML Spec: GET /spec.yaml
• JSON Spec: GET /spec.json

🔧 Development

Code Generation

The server uses OpenAPI code generation. After modifying openapi.yaml:

make oapi-generate

🧪 Testing

Running Tests

make test