Soketi.rs - Yüksek Performanslı WebSocket Sunucusu

Soketi.rs Cover

[ Build Durumu ]actions) [ Versiyon ]releases)

Rust ile yazılmış, yüksek performanslı, Pusher uyumlu WebSocket sunucusu. Soketi.rs, public, private ve presence kanalları desteğiyle gerçek zamanlı mesajlaşma yetenekleri sağlar.

🇬🇧 English Documentation

✨ Özellikler

🚀 Yüksek Performans: Maksimum hız ve verimlilik için Rust ile geliştirildi
📡 Pusher Protokolü: Pusher istemci kütüphaneleriyle %100 uyumlu
🔐 Kimlik Doğrulama: Private ve presence kanalları için yerleşik destek
👥 Presence Kanalları: Gerçek zamanlı kullanıcı takibi ve üye listeleri
💬 İstemci Olayları: Doğrudan istemciden istemciye mesajlaşma
📊 Metrikler: İzleme için Prometheus metrikleri
🔄 Yatay Ölçekleme: Çoklu sunucu dağıtımları için Redis adaptörü
🗄️ Çoklu Backend: MySQL, PostgreSQL, DynamoDB desteği
🎯 Hız Sınırlama: Uygulama başına yapılandırılabilir hız limitleri
🪝 Webhook'lar: HTTP callback'leri ile olay bildirimleri
🐳 Docker Hazır: Production-ready Docker imajları

🚀 Hızlı Başlangıç

Docker Kullanarak (En Hızlı)

# Docker Hub'dan en son imajı çekin ve çalıştırın
docker pull funal/soketi-rs:latest

docker run -d \
  --name soketi \
  -p 6001:6001 \
  -p 9601:9601 \
  funal/soketi-rs:latest

Docker Compose Kullanarak (Önerilen)

# Repository'yi klonlayın
git clone https://github.com/ferdiunal/soketi.rs.git
cd soketi-rs

# Tüm servisleri başlatın
docker-compose up -d

# Logları görüntüleyin
docker-compose logs -f soketi

# Demo'ya erişin
open http://localhost:3000

Cargo Kullanarak

# Rust'ı yükleyin (henüz yüklü değilse)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Derleyin ve çalıştırın
cargo build --release
./target/release/soketi-rs --config-file config.json

Not: Yapılandırma dosyasını belirtmek için --config-file parametresini kullanın.

📦 Kurulum

Gereksinimler

Rust 1.75+ (kaynak koddan derleme için)
Docker & Docker Compose (konteyner dağıtımı için)
Redis (opsiyonel, kümeleme için)
PostgreSQL/MySQL/DynamoDB (opsiyonel, uygulama yönetimi için)

Kaynak Koddan

# Repository'yi klonlayın
git clone https://github.com/ferdiunal/soketi.rs.git
cd soketi-rs

# Release binary'sini derleyin
cargo build --release

# Testleri çalıştırın
cargo test

# Binary'yi yükleyin
cargo install --path .

Docker Kullanarak

# İmajı çekin
docker pull funal/soketi-rs:latest

# Konteyneri çalıştırın
docker run -d \
  -p 6001:6001 \
  -p 9601:9601 \
  -v $(pwd)/config.json:/app/config.json \
  funal/soketi-rs:latest

⚙️ Yapılandırma

Temel Yapılandırma

Bir config.json dosyası oluşturun:

{
  "host": "0.0.0.0",
  "port": 6001,
  "debug": false,
  "app_manager": {
    "driver": "Array",
    "array": {
      "apps": [
        {
          "id": "app-id",
          "key": "app-key",
          "secret": "app-secret",
          "enabled": true,
          "enable_client_messages": true,
          "max_connections": 10000
        }
      ]
    }
  }
}

Ortam Değişkenleri

# Sunucu yapılandırması
SOKETI_HOST=0.0.0.0
SOKETI_PORT=6001
SOKETI_DEBUG=false

# Uygulama yapılandırması
APP_ID=your-app-id
APP_KEY=your-app-key
APP_SECRET=your-app-secret

# Redis (kümeleme için)
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_DB=0

# Metrikler
METRICS_ENABLED=true
METRICS_PORT=9601

Gelişmiş Yapılandırma

Detaylı yapılandırma seçenekleri için [Yapılandırma Kılavuzu]wiki/Yapilandirma) dosyasına bakın:

Uygulama yönetimi (Array, MySQL, PostgreSQL, DynamoDB)
Adaptörler (Local, Redis, NATS, Cluster)
Hız sınırlama ve webhook'lar
Metrikler ve izleme
SSL/TLS yapılandırması

💡 Kullanım Örnekleri

Temel Chat Uygulaması

// Pusher istemcisini başlat
const pusher = new Pusher('app-key', {
  wsHost: 'localhost',
  wsPort: 6001,
  forceTLS: false,
  encrypted: false
});

// Public kanala abone ol
const channel = pusher.subscribe('chat-room');

// Mesajları dinle
channel.bind('new-message', (data) => {
  console.log('Yeni mesaj:', data.message);
  displayMessage(data);
});

// Mesaj gönder (istemci olayları etkinleştirilmiş olmalı)
channel.trigger('client-new-message', {
  user: 'Ahmet',
  message: 'Herkese merhaba!'
});

Kimlik Doğrulama ile Private Kanallar

// Private kanala abone ol
const privateChannel = pusher.subscribe('private-user-123');

// Sunucu tarafı kimlik doğrulama endpoint'i
app.post('/pusher/auth', (req, res) => {
  const socketId = req.body.socket_id;
  const channel = req.body.channel_name;
  
  // Kullanıcının bu kanala erişimi olup olmadığını doğrula
  if (userCanAccessChannel(req.user, channel)) {
    const auth = pusher.authenticate(socketId, channel);
    res.send(auth);
  } else {
    res.status(403).send('Yasak');
  }
});

Presence Kanalları

// Presence kanalına abone ol
const presenceChannel = pusher.subscribe('presence-team');

// Üye eklendi
presenceChannel.bind('pusher:member_added', (member) => {
  console.log('Kullanıcı katıldı:', member.info.name);
  updateUserList();
});

// Üye çıkarıldı
presenceChannel.bind('pusher:member_removed', (member) => {
  console.log('Kullanıcı ayrıldı:', member.info.name);
  updateUserList();
});

// Mevcut üyeleri al
presenceChannel.bind('pusher:subscription_succeeded', (members) => {
  members.each((member) => {
    console.log('Çevrimiçi:', member.info.name);
  });
});

Sunucudan Olay Tetikleme

// Node.js Pusher kütüphanesini kullanarak
const Pusher = require('pusher');

const pusher = new Pusher({
  appId: 'app-id',
  key: 'app-key',
  secret: 'app-secret',
  host: 'localhost',
  port: 6001,
  useTLS: false
});

// Bir olay tetikle
pusher.trigger('my-channel', 'my-event', {
  message: 'Sunucudan merhaba!'
});

// Birden fazla kanala tetikle
pusher.trigger(['channel-1', 'channel-2'], 'my-event', {
  message: 'Yayın mesajı'
});

Daha fazla örnek için:

[Temel Chat Örneği]wiki/Temel-Chat-Ornegi)
[Kimlik Doğrulama Örnekleri]wiki/Kimlik-Dogrulama-Ornekleri)
[Özel Kanallar]wiki/Ozel-Kanallar)
[Presence Kanalları]wiki/Presence-Kanallari)

🐳 Docker Dağıtımı

Tüm deployment dosyaları deployment/ dizininde organize edilmiştir:

deployment/
├── docker/    # Standart Docker deployment
├── nginx/     # Nginx reverse proxy ile
└── caddy/     # Caddy reverse proxy ile (otomatik HTTPS)

Standart Docker Deployment

cd deployment/docker

# Servisleri başlat
docker-compose up -d

# Logları görüntüle
docker-compose logs -f

# Servisleri durdur
docker-compose down

Nginx ile Production Deployment

cd deployment/nginx

# SSL sertifikalarını yapılandır
cp .env.nginx.example .env
# .env dosyasını düzenle

# Servisleri başlat
docker-compose -f docker-compose.nginx.yml up -d

Caddy ile Production Deployment (Otomatik HTTPS)

cd deployment/caddy

# Domain yapılandır
cp .env.caddy.example .env
# .env dosyasını düzenle

# Servisleri başlat (otomatik SSL!)
docker-compose -f docker-compose.caddy.yml up -d

Ölçeklendirme

# Soketi instance'larını ölçeklendirin
docker-compose up -d --scale soketi=3

# Servis durumunu görüntüleyin
docker-compose ps

İzleme Stack'i ile

# Prometheus ve Grafana ile başlatın
docker-compose --profile monitoring up -d

# Grafana'ya erişin
open http://localhost:3001
# Varsayılan kimlik bilgileri: admin/admin

Production En İyi Uygulamaları

Kümeleme için Redis kullanın:

{
  "adapter": {
    "driver": "Redis",
    "redis": {
      "host": "redis",
      "port": 6379
    }
  }
}

Metrikleri etkinleştirin:

{
  "metrics": {
    "enabled": true,
    "driver": "Prometheus",
    "port": 9601
  }
}

Kaynak limitlerini yapılandırın docker-compose.yml dosyasında
Otomatik kurtarma için health check'leri kullanın
Log toplama ayarlayın (ELK, Loki, vb.)

📚 Dokümantasyon

Kapsamlı dokümantasyon birden fazla dilde mevcuttur:

İngilizce Dokümantasyon

[Getting Started]wiki/Getting-Started) - Hızlı başlangıç kılavuzu ve temel kavramlar
[Installation]wiki/Installation) - Detaylı kurulum talimatları
[Configuration]wiki/Configuration) - Tam yapılandırma referansı
[Environment Variables]wiki/Environment-Variables) - Ortam değişkenleri yapılandırma rehberi
[API Reference]wiki/API-Reference) - HTTP ve WebSocket API dokümantasyonu
[Troubleshooting]wiki/Troubleshooting) - Yaygın sorunlar ve çözümler

Deployment Kılavuzları

[Vercel Deployment]wiki/Vercel-Deployment) - Vercel'e deployment
[Netlify Deployment]wiki/Netlify-Deployment) - Netlify'a deployment
[Reverse Proxy Setup]wiki/Reverse-Proxy-Setup) - HTTP/2 ve HTTP/3 ile Caddy ve Nginx yapılandırması

Kod Örnekleri

[Basic Chat]wiki/Basic-Chat-Example) - Basit chat uygulaması
[Authentication]wiki/Authentication-Examples) - Kullanıcı kimlik doğrulama kalıpları
[Private Channels]wiki/Private-Channels) - Güvenli özel mesajlaşma
[Presence Channels]wiki/Presence-Channels) - Gerçek zamanlı kullanıcı varlığı

Türkçe Dokümantasyon

[Başlangıç]wiki/Baslangic) - Hızlı başlangıç kılavuzu ve temel kavramlar
[Kurulum]wiki/Kurulum) - Detaylı kurulum talimatları
[Yapılandırma]wiki/Yapilandirma) - Tam yapılandırma referansı
[Ortam Değişkenleri]wiki/Ortam-Degiskenleri) - Ortam değişkenleri ile yapılandırma rehberi
[API Referansı]wiki/API-Referansi) - HTTP ve WebSocket API dokümantasyonu
[Sorun Giderme]wiki/Sorun-Giderme) - Yaygın sorunlar ve çözümler

Deployment Kılavuzları

[Vercel Deployment]wiki/Vercel-Deployment-TR) - Vercel'e deployment
[Netlify Deployment]wiki/Netlify-Deployment-TR) - Netlify'a deployment
[Reverse Proxy Kurulumu]wiki/Reverse-Proxy-Kurulumu) - HTTP/2 ve HTTP/3 ile Caddy ve Nginx yapılandırması

Kod Örnekleri

[Temel Chat]wiki/Temel-Chat-Ornegi) - Basit chat uygulaması
[Kimlik Doğrulama]wiki/Kimlik-Dogrulama-Ornekleri) - Kullanıcı kimlik doğrulama kalıpları
[Özel Kanallar]wiki/Ozel-Kanallar) - Güvenli özel mesajlaşma
[Presence]wiki/Presence-Kanallari) - Gerçek zamanlı kullanıcı varlığı

İleri Düzey Konular

[MySQL Kurulumu]wiki/MySQL-Setup) - MySQL uygulama yöneticisi yapılandırması
[PostgreSQL Kurulumu]wiki/PostgreSQL-Setup) - PostgreSQL uygulama yöneticisi yapılandırması
[DynamoDB Kurulumu]wiki/DynamoDB-Setup) - DynamoDB uygulama yöneticisi yapılandırması
[Redis Adaptörü]wiki/Redis-Adapter) - Redis kümeleme kurulumu
[NATS Adaptörü]wiki/NATS-Adapter) - NATS mesajlaşma entegrasyonu
[Cluster Adaptörü]wiki/Cluster-Adapter) - Yerel kümeleme
[Lambda Webhook'ları]wiki/Lambda-Webhooks) - AWS Lambda webhook entegrasyonu
[SQS Kuyruk Yöneticisi]wiki/SQS-Queue-Manager) - AWS SQS kuyruk yapılandırması

📚 API Dokümantasyonu

WebSocket Bağlantısı

// Pusher.js kullanarak
const pusher = new Pusher('app-key', {
  wsHost: 'localhost',
  wsPort: 6001,
  forceTLS: false,
  encrypted: false
});

// Kanala abone olun
const channel = pusher.subscribe('my-channel');

// Olayları dinleyin
channel.bind('my-event', (data) => {
  console.log('Alındı:', data);
});

HTTP API

Olay Tetikleme

POST /apps/{app_id}/events
Content-Type: application/json

{
  "name": "my-event",
  "channel": "my-channel",
  "data": "{\"message\":\"Merhaba Dünya\"}"
}

Kanalları Getir

GET /apps/{app_id}/channels

Kanal Bilgisi Getir

GET /apps/{app_id}/channels/{channel_name}

Tam API dokümantasyonu için [API Referansı]wiki/API-Referansi) dosyasına bakın.

📱 İstemci Kütüphaneleri

Soketi.rs tüm Pusher istemci kütüphaneleriyle uyumludur:

JavaScript: pusher-js
Laravel: Laravel Echo
iOS: pusher-websocket-swift
Android: pusher-websocket-java
Python: pusher-http-python
PHP: pusher-http-php
Ruby: pusher-http-ruby
Go: pusher-http-go

🏗️ Mimari

┌─────────────────┐
│  İstemci Uyg.   │
│  (Web/Mobil)    │
└────────┬────────┘
         │ WebSocket
         ▼
┌─────────────────┐
│ Soketi Sunucu   │
│     (Rust)      │
└────────┬────────┘
         │
    ┌────┴────┬────────┬─────────┐
    ▼         ▼        ▼         ▼
┌───────┐ ┌───────┐ ┌──────┐ ┌────────┐
│ Redis │ │  VT   │ │Metrik│ │Webhook │
└───────┘ └───────┘ └──────┘ └────────┘

Bileşenler

WebSocket Sunucusu: İstemci bağlantılarını yönetir
HTTP API: Olay tetikleme için REST API
Adaptör: Mesaj dağıtımı (Local/Redis/NATS/Cluster)
Uygulama Yöneticisi: Uygulama yapılandırması (Array/MySQL/PostgreSQL/DynamoDB)
Önbellek Yöneticisi: Önbellekleme katmanı (Memory/Redis)
Hız Sınırlayıcı: İstek hız sınırlama (Local/Redis)
Kuyruk Yöneticisi: Webhook kuyruğu (Sync/Redis/SQS)
Metrikler: Prometheus metrik dışa aktarıcı

📊 Performans

Benchmark'lar

Bağlantılar: Instance başına 100.000+ eşzamanlı bağlantı
Mesajlar: Saniyede 1M+ mesaj
Gecikme: <1ms ortalama mesaj gecikmesi
Bellek: ~50MB temel + bağlantı başına ~1KB
CPU: Verimli çok çekirdekli kullanım

Optimizasyon İpuçları

Yatay ölçekleme için Redis adaptörü kullanın
Bağlantı havuzlamayı etkinleştirin
Uygun hız limitlerini yapılandırın
Kalıcılık için SSD depolama kullanın
İzleme için Prometheus metriklerini etkinleştirin

🧪 Test

# Tüm testleri çalıştır
cargo test

# Belirli bir testi çalıştır
cargo test test_name

# Loglama ile çalıştır
RUST_LOG=debug cargo test

# Benchmark'ları çalıştır
cargo bench

🤝 Katkıda Bulunma

Katkılar memnuniyetle karşılanır! Detaylar için CONTRIBUTING.md dosyasını okuyun.

Geliştirme Ortamı Kurulumu

# Repository'yi klonlayın
git clone https://github.com/ferdiunal/soketi.rs.git
cd soketi-rs

# Bağımlılıkları yükleyin
cargo build

# Testleri çalıştırın
cargo test

# Demo'yu çalıştırın
cargo run -- --config-file test-config.json

📄 Lisans

Bu proje GPL-3.0 Lisansı altında lisanslanmıştır - detaylar için LICENSE dosyasına bakın.

🙏 Teşekkürler

Soketi'den ilham alınmıştır
Tokio ile geliştirilmiştir
Pusher Protokolü ile uyumludur

📞 Destek

Dokümantasyon: [English]wiki/Getting-Started) | [Türkçe]wiki/Baslangic)
Sorunlar: [GitHub Issues]issues)
Tartışmalar: [GitHub Discussions]discussions)
Discord: Discord'umuza katılın

Ferdi ÜNAL tarafından ❤️ ile yapıldı

soketi-rs 1.0.2

Soketi.rs - Yüksek Performanslı WebSocket Sunucusu

✨ Özellikler

📋 İçindekiler

🚀 Hızlı Başlangıç

Docker Kullanarak (En Hızlı)

Docker Compose Kullanarak (Önerilen)

Cargo Kullanarak

📦 Kurulum

Gereksinimler

Kaynak Koddan

Docker Kullanarak

⚙️ Yapılandırma

Temel Yapılandırma

Ortam Değişkenleri

Gelişmiş Yapılandırma

💡 Kullanım Örnekleri

Temel Chat Uygulaması

Kimlik Doğrulama ile Private Kanallar

Presence Kanalları

Sunucudan Olay Tetikleme

🐳 Docker Dağıtımı

Standart Docker Deployment

Nginx ile Production Deployment

Caddy ile Production Deployment (Otomatik HTTPS)

Ölçeklendirme

İzleme Stack'i ile

Production En İyi Uygulamaları

📚 Dokümantasyon

İngilizce Dokümantasyon

Deployment Kılavuzları

Kod Örnekleri

Türkçe Dokümantasyon

Deployment Kılavuzları

Kod Örnekleri

İleri Düzey Konular

📚 API Dokümantasyonu

WebSocket Bağlantısı

HTTP API

Olay Tetikleme

Kanalları Getir

Kanal Bilgisi Getir

📱 İstemci Kütüphaneleri

🏗️ Mimari

Bileşenler

📊 Performans

Benchmark'lar

Optimizasyon İpuçları

🧪 Test

🤝 Katkıda Bulunma

Geliştirme Ortamı Kurulumu

📄 Lisans

🙏 Teşekkürler

📞 Destek