HOME

Soketi.rs Documentation

Welcome to the Soketi.rs documentation! This directory contains comprehensive guides for using and deploying Soketi.rs.

Documentation Structure

English Documentation (/en)

Getting Started

• Installation - How to install Soketi.rs
• Getting Started - Quick start guide
• Configuration - Configuration options
• API Reference - Complete API documentation

Deployment

• Docker Guide - Quick Docker commands and setup
• Docker Deployment - Complete Docker deployment guide
• Database Setup - PostgreSQL, MySQL, and DynamoDB setup
• Deployment Guide - Production deployment strategies
• Reverse Proxy - Nginx and HAProxy configuration
• Netlify - Deploy to Netlify
• Vercel - Deploy to Vercel

Examples

• Basic Chat - Simple chat application
• Authentication - User authentication
• Private Channels - Private channel usage
• Presence - Presence channel examples

Advanced Features

• Redis Adapter - Horizontal scaling with Redis
• NATS Adapter - Horizontal scaling with NATS
• Cluster Adapter - Multi-instance clustering
• Lambda Webhooks - AWS Lambda integration
• SQS Queue - AWS SQS queue manager
• Validation - Message validation

Troubleshooting

• Troubleshooting - Common issues and solutions

Türkçe Döküman (/tr)

Başlangıç

• Kurulum - Soketi.rs kurulumu
• Başlangıç - Hızlı başlangıç rehberi
• Yapılandırma - Yapılandırma seçenekleri
• API Referans - Tam API dokümantasyonu

Deployment

• Docker Rehberi - Hızlı Docker komutları ve kurulum
• Docker Deployment - Tam Docker deployment rehberi
• Veritabanı Kurulumu - PostgreSQL, MySQL ve DynamoDB kurulumu
• Reverse Proxy - Nginx ve HAProxy yapılandırması
• Netlify - Netlify'a deploy
• Vercel - Vercel'e deploy

Örnekler

• Temel Chat - Basit chat uygulaması
• Kimlik Doğrulama - Kullanıcı kimlik doğrulama
• Özel Kanallar - Private channel kullanımı
• Presence - Presence channel örnekleri

Sorun Giderme

• Sorun Giderme - Yaygın sorunlar ve çözümler

Quick Links

For Users

• 🚀 Quick Start (EN) | Hızlı Başlangıç (TR)
• 🐳 Docker Guide (EN) | Docker Rehberi (TR)
• 📖 API Reference (EN) | API Referans (TR)

For Developers

• 🔧 Configuration (EN) | Yapılandırma (TR)
• 💾 Database Setup (EN) | Veritabanı Kurulumu (TR)
• 🚀 Deployment (EN)

Advanced Topics

• 📡 Redis Adapter - Horizontal scaling
• 🔗 NATS Adapter - Message distribution
• ⚡ Lambda Webhooks - Serverless webhooks
• 📊 SQS Queue - Async job processing

Contributing

Found an issue or want to improve the documentation? Contributions are welcome!

1. Fork the repository
2. Create your feature branch
3. Make your changes
4. Submit a pull request

Support

• GitHub Issues: Report a bug
• GitHub Discussions: Ask questions
• Docker Hub: ferdiunal/soketi-rs

License

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