Skip to content

VM_DEPLOYMENT_GUIDE.md

Latest commit

 

History

History
425 lines (314 loc) · 21.6 KB

VM_DEPLOYMENT_GUIDE.md

File metadata and controls

425 lines (314 loc) · 21.6 KB
Raw

OmniRoute — Deployment Guide on VM with Cloudflare (Türkçe)

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇧🇦 bs · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇱 he · 🇮🇳 hi · 🇭🇷 hr · 🇭🇺 hu · 🇦🇲 hy · 🇮🇩 id · 🇳🇬 ig · 🇮🇹 it · 🇯🇵 ja · 🇬🇪 ka · 🇰🇭 km · 🇮🇳 kn · 🇰🇷 ko · 🇱🇹 lt · 🇱🇻 lv · 🇮🇳 ml · 🇮🇳 mr · 🇲🇾 ms · 🇲🇹 mt · 🇲🇲 my · 🇳🇵 ne · 🇳🇱 nl · 🇳🇴 no · 🇮🇳 or · 🇮🇳 pa · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇱🇰 si · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇧🇦 bs · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇱 he · 🇮🇳 hi · 🇭🇷 hr · 🇭🇺 hu · 🇦🇲 hy · 🇮🇩 id · 🇳🇬 ig · 🇮🇹 it · 🇯🇵 ja · 🇬🇪 ka · 🇰🇭 km · 🇮🇳 kn · 🇰🇷 ko · 🇱🇹 lt · 🇱🇻 lv · 🇮🇳 ml · 🇮🇳 mr · 🇲🇾 ms · 🇲🇹 mt · 🇲🇲 my · 🇳🇵 ne · 🇳🇱 nl · 🇳🇴 no · 🇮🇳 or · 🇮🇳 pa · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇱🇰 si · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW

Cloudflare üzerinden yönetilen bir alan adıyla OmniRoute'u bir sanal makineye (VPS) kurmak ve yapılandırmak için kapsamlı kılavuz.

Ön Koşullar

Öğe Minimum Önerilen
CPU 1 vCPU 2 vCPU
RAM 1 GB 2 GB
Disk 10 GB SSD 25 GB SSD
İşletim Sistemi Ubuntu 22.04 LTS Ubuntu 24.04 LTS
Alan Adı Cloudflare'a kaydedilmiş —
Docker Docker Engine 24+ Docker 27+

Test edilen sağlayıcılar: Akamai (Linode), DigitalOcean, Vultr, Hetzner, AWS Lightsail.

1. Sanal Makineyi Yapılandırın

1.1 Sunucuyu oluşturun

Tercih ettiğiniz VPS sağlayıcısında:

  • Ubuntu 24.04 LTS'yi seçin
  • Minimum planı seçin (1 vCPU / 1 GB RAM)
  • Güçlü bir root parolası belirleyin veya SSH anahtarı yapılandırın
  • Genel IP adresini not edin (ör. 203.0.113.10)

1.2 SSH üzerinden bağlanın

ssh root@203.0.113.10

1.3 Sistemi güncelleyin

apt update && apt upgrade -y

1.4 Docker'ı yükleyin

# Bağımlılıkları yükleyin
apt install -y ca-certificates curl gnupg

# Resmî Docker deposunu ekleyin
install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg
chmod a+r /etc/apt/keyrings/docker.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu $ (. /etc/os-release && echo "$VERSION_CODENAME") stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null
apt update
apt install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin

1.5 nginx'i yükleyin

apt install -y nginx

1.6 Güvenlik Duvarını (UFW) yapılandırın

ufw default deny incoming
ufw default allow outgoing
ufw allow 22/tcp    # SSH
ufw allow 80/tcp    # HTTP (yönlendirme)
ufw allow 443/tcp   # HTTPS
ufw enable

İpucu: En yüksek güvenlik için 80 ve 443 numaralı bağlantı noktalarını yalnızca Cloudflare IP'leriyle sınırlandırın. Gelişmiş Güvenlik bölümüne bakın.

2. OmniRoute'u Yükleyin

2.1 Yapılandırma dizinini oluşturun

mkdir -p /opt/omniroute

2.2 Ortam değişkenleri dosyasını oluşturun

cat > /opt/omniroute/.env << 'EOF'
# === Güvenlik ===
JWT_SECRET=CHANGE-TO-A-UNIQUE-64-CHAR-SECRET-KEY
INITIAL_PASSWORD=YourSecurePassword123!
API_KEY_SECRET=REPLACE-WITH-ANOTHER-SECRET-KEY
STORAGE_ENCRYPTION_KEY=REPLACE-WITH-THIRD-SECRET-KEY
STORAGE_ENCRYPTION_KEY_VERSION=v1
MACHINE_ID_SALT=CHANGE-TO-A-UNIQUE-SALT
OMNIROUTE_WS_BRIDGE_SECRET=REPLACE-WITH-WS-BRIDGE-SECRET  # Üretimde GEREKLİDİR: Codex Responses WS köprüsü tarafından kullanılır

# === Uygulama ===
PORT=20128
NODE_ENV=production
HOSTNAME=0.0.0.0
DATA_DIR=/app/data
APP_LOG_TO_FILE=true
AUTH_COOKIE_SECURE=true
REQUIRE_API_KEY=false

# === URL'ler (kendi alan adınızla değiştirin) ===
# Zamanlanmış görevler / kendi kendine yapılan istekler için sunucudan sunucuya dahili temel URL.
BASE_URL=http://127.0.0.1:20128
# OAuth geri çağrıları, kontrol paneli bağlantıları ve oluşturulan genel URL'ler için kullanılan, tarayıcıya yönelik URL.
NEXT_PUBLIC_BASE_URL=https://llms.seudominio.com
# Oluşturulan genel varlık URL'leri için isteğe bağlı açık genel kaynak geçersiz kılma değeri.
# OMNIROUTE_PUBLIC_BASE_URL=https://llms.seudominio.com

# === Bulut Senkronizasyonu (isteğe bağlı) ===
# CLOUD_URL=https://cloud.omniroute.online
# NEXT_PUBLIC_CLOUD_URL=https://cloud.omniroute.online
EOF

⚠️ ÖNEMLİ: Benzersiz gizli anahtarlar oluşturun! Her anahtar için openssl rand -hex 32 kullanın.

2.3 Konteyneri başlatın

docker pull diegosouzapw/omniroute:latest

docker run -d \
  --name omniroute \
  --restart unless-stopped \
  --env-file /opt/omniroute/.env \
  -p 20128:20128 \
  -v omniroute-data:/app/data \
  diegosouzapw/omniroute:latest

2.4 Çalıştığını doğrulayın

docker ps | grep omniroute
docker logs omniroute --tail 20

Şunları göstermelidir: [DB] SQLite database ready ve listening on port 20128.

3. nginx'i Yapılandırma (Ters Proxy)

3.1 SSL sertifikası oluşturma (Cloudflare Origin)

Cloudflare kontrol panelinde:

  1. SSL/TLS → Origin Server bölümüne gidin
  2. Create Certificate seçeneğine tıklayın
  3. Varsayılan ayarları koruyun (15 yıl, *.yourdomain.com)
  4. Origin Certificate ve Private Key değerlerini kopyalayın
mkdir -p /etc/nginx/ssl

# Sertifikayı yapıştırın
nano /etc/nginx/ssl/origin.crt

# Özel anahtarı yapıştırın
nano /etc/nginx/ssl/origin.key

chmod 600 /etc/nginx/ssl/origin.key

3.2 Nginx Yapılandırması

cat > /etc/nginx/sites-available/omniroute << 'NGINX'
# Varsayılan sunucu — IP üzerinden doğrudan erişimi engeller
server {
    listen 80 default_server;
    listen [::]:80 default_server;
    listen 443 ssl default_server;
    listen [::]:443 ssl default_server;
    ssl_certificate     /etc/nginx/ssl/origin.crt;
    ssl_certificate_key /etc/nginx/ssl/origin.key;
    server_name _;
    return 444;
}

# OmniRoute — HTTPS
server {
    listen 443 ssl;
    listen [::]:443 ssl;
    server_name llms.yourdomain.com;  # Alan adınızla değiştirin

    ssl_certificate     /etc/nginx/ssl/origin.crt;
    ssl_certificate_key /etc/nginx/ssl/origin.key;
    ssl_protocols TLSv1.2 TLSv1.3;

    client_max_body_size 100M;

    location / {
        proxy_pass http://127.0.0.1:20128;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        # WebSocket desteği
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        # SSE (Sunucu Tarafından Gönderilen Olaylar) — akış hâlindeki yapay zekâ yanıtları
        proxy_buffering off;
        proxy_cache off;
        proxy_read_timeout 600s;
        proxy_send_timeout 600s;
    }
}

# HTTP → HTTPS yönlendirmesi
server {
    listen 80;
    listen [::]:80;
    server_name llms.yourdomain.com;
    return 301 https://$server_name$request_uri;
}
NGINX

Ters proxy akış zaman aşımlarını OmniRoute zaman aşımı ortam değişkenlerinizle uyumlu tutun. FETCH_TIMEOUT_MS / STREAM_IDLE_TIMEOUT_MS değerlerini artırırsanız proxy_read_timeout / proxy_send_timeout değerlerini de aynı eşiğin üzerine çıkarın.

OmniRoute, OAuth geri çağrıları ve oluşturulan herkese açık bağlantılar için tarayıcıya yönelik standart kaynak olarak NEXT_PUBLIC_BASE_URL kullanır. Kimliği doğrulanmış kontrol paneli yazma işlemleri, aynı kaynaklı isteklerin yanı sıra oturuma bağlı CSRF korumasını kullanır; bu nedenle statik bir herkese açık temel URL gerektirmez. Yukarıdaki X-Forwarded-* başlıkları yönlendirme meta verileri olarak yine de kullanışlıdır, ancak OAuth veya oluşturulan tarayıcı bağlantıları için gerektiğinde açıkça belirtilen herkese açık URL'nin ayarlanmasının yerine geçmez. OMNIROUTE_TRUST_PROXY seçeneğini yalnızca OmniRoute istemciler tarafından doğrudan erişilebilir değilse ve proxy'niz gelen iletilmiş başlıkları kaldırıp yeniden oluşturuyorsa etkinleştirin.

3.3 Etkinleştirme ve Test Etme

# Varsayılan yapılandırmayı kaldırın
rm -f /etc/nginx/sites-enabled/default

# OmniRoute'u etkinleştirin
ln -sf /etc/nginx/sites-available/omniroute /etc/nginx/sites-enabled/omniroute

# Test edin ve yeniden yükleyin
nginx -t && systemctl reload nginx

4. Cloudflare DNS'i Yapılandırma

4.1 DNS kaydı ekleme

Cloudflare kontrol panelinde → DNS:

Tür Ad İçerik Proxy
A llms 203.0.113.10 (VM IP'si) ✅ Proxy'li

4.2 SSL'i yapılandırma

SSL/TLS → Overview altında:

  • Mod: Full (Strict)

SSL/TLS → Edge Certificates altında:

  • Her Zaman HTTPS Kullan: ✅ Açık
  • Minimum TLS Sürümü: TLS 1.2
  • Otomatik HTTPS Yeniden Yazımları: ✅ Açık

4.3 Test

curl -sI https://llms.seudominio.com/health
# HTTP/2 200 döndürmelidir

5. İşletim ve Bakım

Yeni bir sürüme yükseltme

docker pull diegosouzapw/omniroute:latest
docker stop omniroute && docker rm omniroute
docker run -d --name omniroute --restart unless-stopped \
  --env-file /opt/omniroute/.env \
  -p 20128:20128 \
  -v omniroute-data:/app/data \
  diegosouzapw/omniroute:latest

Günlükleri görüntüleme

docker logs -f omniroute          # Gerçek zamanlı akış
docker logs omniroute --tail 50   # Son 50 satır

Manuel veritabanı yedeklemesi

# Verileri birimden ana makineye kopyalayın
docker cp omniroute:/app/data ./backup-$(date +%F)

# Veya birimin tamamını sıkıştırın
docker run --rm -v omniroute-data:/data -v $(pwd):/backup \
  alpine tar czf /backup/omniroute-data-$(date +%F).tar.gz /data

Yedekten geri yükleme

docker stop omniroute
docker run --rm -v omniroute-data:/data -v $(pwd):/backup \
  alpine sh -c "rm -rf /data/* && tar xzf /backup/omniroute-data-YYYY-MM-DD.tar.gz -C /"
docker start omniroute

6. Gelişmiş Güvenlik

nginx'i Cloudflare IP'leriyle sınırlandırma

cat > /etc/nginx/cloudflare-ips.conf << 'CF'
# Cloudflare IPv4 aralıkları — düzenli olarak güncelleyin
# https://www.cloudflare.com/ips-v4/
set_real_ip_from 173.245.48.0/20;
set_real_ip_from 103.21.244.0/22;
set_real_ip_from 103.22.200.0/22;
set_real_ip_from 103.31.4.0/22;
set_real_ip_from 141.101.64.0/18;
set_real_ip_from 108.162.192.0/18;
set_real_ip_from 190.93.240.0/20;
set_real_ip_from 188.114.96.0/20;
set_real_ip_from 197.234.240.0/22;
set_real_ip_from 198.41.128.0/17;
set_real_ip_from 162.158.0.0/15;
set_real_ip_from 104.16.0.0/13;
set_real_ip_from 104.24.0.0/14;
set_real_ip_from 172.64.0.0/13;
set_real_ip_from 131.0.72.0/22;
real_ip_header CF-Connecting-IP;
CF

Aşağıdakini nginx.conf dosyasındaki http {} bloğunun içine ekleyin:

include /etc/nginx/cloudflare-ips.conf;

fail2ban'i yükleme

apt install -y fail2ban
systemctl enable fail2ban
systemctl start fail2ban

# Durumu kontrol edin
fail2ban-client status sshd

Docker portuna doğrudan erişimi engelleme

# 20128 numaralı porta doğrudan harici erişimi engelleyin
iptables -I DOCKER-USER -p tcp --dport 20128 -j DROP
iptables -I DOCKER-USER -i lo -p tcp --dport 20128 -j ACCEPT

# Kuralları kalıcı hâle getirin
apt install -y iptables-persistent
netfilter-persistent save

7. Cloudflare Workers'a Dağıtım (İsteğe Bağlı)

VM'yi doğrudan erişime açmadan Cloudflare Workers üzerinden uzaktan erişim için:

# Yerel depoda
cd omnirouteCloud
npm install
npx wrangler login
npx wrangler deploy

Depo içindeki Cloudflare Tunnel adım adım kılavuzu için ayrıca TUNNELS_GUIDE.md dosyasına bakın. Bağımsız omnirouteCloud/ worker'ı, ayrı bir yardımcı depoda bulunur.

Port Özeti

Port Hizmet Erişim
22 SSH Herkese açık (fail2ban ile)
80 nginx HTTP Yönlendirme → HTTPS
443 nginx HTTPS Cloudflare Proxy üzerinden
20128 OmniRoute Yalnızca localhost (nginx üzerinden)

Düşük Bellekli / Küçük VPS Optimizasyonu

Küçük VPS örneklerindeki (1 GB RAM veya daha az) dağıtımlar için:

  • Arka plan hizmetlerini devre dışı bırakın — zamanlayıcıyı, MCP sunucusunu ve düzenli bakım görevlerini atlamak için OMNIROUTE_DISABLE_BACKGROUND_SERVICES=1 olarak ayarlayın. Bkz. docs/reference/ENVIRONMENT.md.
  • SQLite WAL modunu kullanın — varsayılan olarak etkindir ve eşzamanlı okumalar sırasında en yüksek bellek kullanımını azaltır.
  • V8 yığınını sınırlayın — çalışma zamanının VM'den daha büyük bir üst sınır belirlememesi için OMNIROUTE_MEMORY_MB değerini (ör. 512) ayarlayın. Bkz. docs/reference/ENVIRONMENT.md.
  • Ağır iş yükü kabulü, yığın sınırına göre otomatik olarak ölçeklenir -- yukarıda OMNIROUTE_MEMORY_MB ayarlandığında veri alımı bayt bütçesi (OMNIROUTE_CHAT_MAX_INFLIGHT_BYTES) aynı üst sınırdan otomatik olarak türetilir; böylece belleği kısıtlı bir VM, ek ayar gerektirmeden daha düşük bir eşzamanlı istek bütçesine sahip olur. Fazla istekler bellek için rekabet etmek yerine Retry-After ile yeniden denenebilir bir 503 yanıtı alır. Yalnızca buna ek olarak katı bir üst sınır gerekiyorsa eski OMNIROUTE_CHAT_MAX_HEAVY_IN_FLIGHT istek sayısı sınırını ayarlayın.
  • VPS üzerinde next build çalıştırmaktan kaçının — derlemeyi yerel olarak yapın ve bağımsız çıktıyı (.next/standalone/) dağıtın.
  • top / free -m ile izleyin — OmniRoute, 1 GB'lık bir VM'de boşta çalışırken genellikle 200-400 MB RSS kullanır.