OpenMux - Open Source Alternative to Mux

🚀 Introduction

OpenMux is an open-source alternative to Mux, providing a scalable and developer-friendly API for video encoding, streaming, and playback. Whether you're building a video-sharing platform, a live-streaming service, or an educational content platform, OpenMux gives you the tools you need without the vendor lock-in.

🌟 Features

• 🎥 Video Upload & Encoding: Supports multiple formats and resolutions.
• 📡 Live Streaming: RTMP ingest and HLS playback.
• 🔥 Adaptive Bitrate Streaming (ABR): Ensures smooth playback across devices.
• 🗄️ Storage Integration: Works with AWS S3, Google Cloud Storage, and local storage.
• 📊 Analytics: Real-time video insights and engagement tracking.
• 🛡 Security: Token-based access control, watermarking, and DRM support.
• 🛠 Developer-Friendly API: RESTful API and Webhooks for seamless integration.
• 🌐 Web3 Integration: NFT-based video access, decentralized storage (IPFS, Arweave), and crypto payments.

🎯 Roadmap

• Add WebRTC support for ultra-low latency streaming.
• Implement server-side ad insertion (SSAI).
• Expand cloud provider integrations.
• Develop a React-based video player component.
• Web3 smart contract integration for NFT video access.
• Support for decentralized storage (IPFS, Arweave).

🏗 Installation

Prerequisites

• Node.js (>=16.x)
• PostgreSQL or MongoDB
• FFmpeg (for video processing)
• Docker (optional, for deployment)
• MetaMask or WalletConnect (for Web3 integration)

Steps

1. Clone the Repository:

   git clone https://github.com/yourusername/openmux.git
   cd openmux

2. Install Dependencies:

   npm install

3. Set Up Environment Variables:

   cp .env.example .env
   # Update the .env file with your configurations

4. Run Migrations (for PostgreSQL users):

   npm run migrate

5. Start the Server:

   npm start

📖 API Documentation

Check out our full API docs at https://docs.openmux.io.

Example: Upload a Video

curl -X POST "https://api.openmux.io/videos" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -F "file=@video.mp4"

Example: Retrieve Video Details

curl -X GET "https://api.openmux.io/videos/{video_id}" \
     -H "Authorization: Bearer YOUR_API_KEY"

Web3 Example: Verify NFT Ownership for Video Access

const ethers = require("ethers");
const contractAddress = "0xYourContractAddress";
const abi = ["function ownerOf(uint256 tokenId) view returns (address)"];

async function checkOwnership(tokenId, userAddress) {
  const provider = new ethers.providers.JsonRpcProvider("https://your_rpc_url");
  const contract = new ethers.Contract(contractAddress, abi, provider);
  const owner = await contract.ownerOf(tokenId);
  return owner.toLowerCase() === userAddress.toLowerCase();
}

📦 Deployment

Using Docker

docker-compose up -d

Deploying to Vercel (Frontend) & Render/Fly.io (Backend)

1. Push your repo to GitHub.
2. Connect your repo to Render or Fly.io for backend hosting.
3. Deploy the frontend on Vercel or Netlify.

🤝 Contributing

We welcome contributions! Please read our CONTRIBUTING.md for guidelines.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🎉 Acknowledgments

• Inspired by Mux
• Built with ❤️ by Your Name

🌍 Community & Support

• 📢 Join our Discord: Invite Link
• 🐦 Follow us on Twitter: @OpenMux
• 📧 Contact us: support@openmux.io