aircloud05/aircloud-rtmp repository overview

AirCloud is a containerized streaming infrastructure project that provides real-time media streaming capabilities through RTMP (Real-Time Messaging Protocol) services with integrated authentication mechanisms.

⁠Architecture

The project consists of a microservices architecture deployed using Docker Compose, featuring two primary services:

⁠Services

⁠RTMP Service (rtmp)

• Container: rtmp_server
• Image: aircloud-rtmp:latest
• Purpose: Handles real-time media streaming protocol operations
• Exposed Ports:
  • 1935: Standard RTMP port for streaming connections
  • 8080: Web interface/HTTP management port
• Features: Always-restart policy for high availability

⁠Authentication Service (auth)

• Container: auth_server
• Image: aircloud-auth:latest
• Purpose: Manages user authentication and authorization
• Exposed Ports:
  • 8004: Authentication API endpoint
• Features: Always-restart policy for continuous availability

⁠Network Configuration

• Network Name: aircloud-network
• Driver: Bridge networking for isolated container communication
• Inter-service Communication: Services can communicate internally using container names

⁠Deployment

⁠Prerequisites

• Docker Engine
• Docker Compose v3.9+

⁠Quick Start

# Start all services
docker-compose up -d

# Check service status
docker-compose ps

# View logs
docker-compose logs -f

⁠Service Access

• RTMP Streaming: rtmp://localhost:1935
• RTMP Web Interface: http://localhost:8080
• Authentication API: http://localhost:8004

⁠Use Cases

• Live Streaming: Real-time video/audio broadcasting
• Media Server: Centralized streaming infrastructure
• Authenticated Streaming: Secure streaming with user verification
• Development Environment: Local streaming setup for testing

⁠Configuration Notes

• All services use latest image tags for most recent features
• Restart policies ensure automatic recovery from failures
• Bridge networking provides service isolation while enabling communication
• Port mappings allow external access to key service endpoints

⁠Development

The project appears to use custom Docker images (aircloud-rtmp and aircloud-auth), indicating either:

• Custom-built images from local Dockerfiles
• Private registry deployment
• Images built as part of a CI/CD pipeline

For development, ensure the required images are built or available before running docker-compose up.