Vyral Docs

Vyral Documentation

Complete setup and configuration guide for your Vyral social media platform

Vyral Documentation

Welcome to Vyral - a modern social media platform with real-time messaging, video calls, monetization, and community features.

Quick Installation

Get your platform running in minutes with our automated setup script

SMTP Configuration

Set up email delivery for notifications and transactional emails

Storage Setup

Configure file uploads with local storage or cloud providers

CoTURN Server

Enable reliable WebRTC video and voice calls

What's Included

Vyral comes with everything you need to launch a modern social media platform:

🔥 Core Features

  • Real-time Messaging: WebSocket-powered instant messaging
  • Video/Voice Calls: WebRTC peer-to-peer calls with CoTURN support
  • Communities: Create and manage topic-based communities
  • Location Features: Discover nearby users and location-based content
  • Stories: Share temporary content with followers

💰 Monetization

  • Virtual Gifts: Users can send and receive virtual gifts
  • Tipping System: Direct tips between users
  • Subscriptions: Creator monetization with subscription tiers
  • Premium Content: Paywall support for exclusive content

🛠 Technical Features

  • Multi-language Support: 12+ built-in languages with RTL support
  • Admin Dashboard: Comprehensive management interface
  • Analytics: User engagement and platform analytics
  • Moderation Tools: Content and user moderation features
  • PWA Ready: Mobile-optimized with offline support

Quick Start

# Upload the regular/ folder to your server
cd /path/to/vyral/regular/

# Configure your domains
nano config.sh

# Run the setup script
chmod +x setup.sh
sudo ./setup.sh
# If you already have Docker installed
cd /path/to/vyral/regular/
docker compose up --build -d
# Follow the detailed installation guide
# for manual configuration steps

System Requirements

  • OS: Ubuntu 18.04+ or similar Linux distribution
  • RAM: 4GB minimum, 8GB recommended
  • Storage: 20GB minimum, 50GB+ for production
  • Domains: 2 domains with SSL certificates
  • Access: Root or sudo privileges

Support

Need help? Check out our comprehensive guides:

Ready to get started? Begin with our Installation Guide.

Changelog

Next Page