Skip to content

Latest commit

 

History

History
433 lines (322 loc) · 20.6 KB

VM_DEPLOYMENT_GUIDE.md

File metadata and controls

433 lines (322 loc) · 20.6 KB

OmniRoute — Deployment Guide on VM with Cloudflare (Bahasa Indonesia)

🌐 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 · 🇳🇬 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 · 🇹🇷 tr · 🇺🇦 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 · 🇳🇬 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 · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW

Panduan lengkap untuk menginstal dan mengonfigurasi OmniRoute pada VM (VPS) dengan domain yang dikelola melalui Cloudflare.


Prasyarat

Item Minimum Direkomendasikan
CPU 1 vCPU 2 vCPU
RAM 1 GB 2 GB
Disk 10 GB SSD 25 GB SSD
OS Ubuntu 22.04 LTS Ubuntu 24.04 LTS
Domain Terdaftar di Cloudflare —
Docker Docker Engine 24+ Docker 27+

Penyedia yang telah diuji: Akamai (Linode), DigitalOcean, Vultr, Hetzner, AWS Lightsail.


1. Konfigurasikan VM

1.1 Buat instans

Di penyedia VPS pilihan Anda:

  • Pilih Ubuntu 24.04 LTS
  • Pilih paket minimum (1 vCPU / 1 GB RAM)
  • Tetapkan kata sandi root yang kuat atau konfigurasikan kunci SSH
  • Catat IP publik (misalnya, 203.0.113.10)

1.2 Hubungkan melalui SSH

ssh root@203.0.113.10

1.3 Perbarui sistem

apt update && apt upgrade -y

1.4 Instal Docker

# Instal dependensi
apt install -y ca-certificates curl gnupg

# Tambahkan repositori resmi Docker
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 Instal nginx

apt install -y nginx

1.6 Konfigurasikan Firewall (UFW)

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

Kiat: Untuk keamanan maksimum, batasi port 80 dan 443 hanya untuk IP Cloudflare. Lihat bagian Keamanan Tingkat Lanjut.


2. Instal OmniRoute

2.1 Buat direktori konfigurasi

mkdir -p /opt/omniroute

2.2 Buat file variabel lingkungan

cat > /opt/omniroute/.env << 'EOF'
# === Keamanan ===
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  # WAJIB dalam produksi: digunakan oleh bridge WS Codex Responses

# === Aplikasi ===
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 (ubah ke domain Anda) ===
# URL dasar internal antarpeladen untuk tugas terjadwal / pengambilan mandiri.
BASE_URL=http://127.0.0.1:20128
# URL yang diakses peramban dan digunakan untuk callback OAuth, tautan dasbor, serta URL publik yang dihasilkan.
NEXT_PUBLIC_BASE_URL=https://llms.seudominio.com
# Penggantian origin publik eksplisit opsional untuk URL aset publik yang dihasilkan.
# OMNIROUTE_PUBLIC_BASE_URL=https://llms.seudominio.com

# === Sinkronisasi Cloud (opsional) ===
# CLOUD_URL=https://cloud.omniroute.online
# NEXT_PUBLIC_CLOUD_URL=https://cloud.omniroute.online
EOF

⚠️ PENTING: Buat kunci rahasia yang unik! Gunakan openssl rand -hex 32 untuk setiap kunci.

2.3 Jalankan kontainer

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 Verifikasi bahwa kontainer sedang berjalan

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

Output seharusnya menampilkan: [DB] SQLite database ready dan listening on port 20128.


3. Konfigurasi nginx (Proksi Terbalik)

3.1 Buat sertifikat SSL (Cloudflare Origin)

Di dasbor Cloudflare:

  1. Buka SSL/TLS → Origin Server
  2. Klik Create Certificate
  3. Pertahankan pengaturan default (15 tahun, *.yourdomain.com)
  4. Salin Origin Certificate dan Private Key
mkdir -p /etc/nginx/ssl

# Tempelkan sertifikat
nano /etc/nginx/ssl/origin.crt

# Tempelkan kunci privat
nano /etc/nginx/ssl/origin.key

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

3.2 Konfigurasi Nginx

cat > /etc/nginx/sites-available/omniroute << 'NGINX'
# Server default — memblokir akses langsung melalui IP
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;  # Ubah ke domain Anda

    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;

        # Dukungan WebSocket
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";

        # SSE (Server-Sent Events) — respons AI streaming
        proxy_buffering off;
        proxy_cache off;
        proxy_read_timeout 600s;
        proxy_send_timeout 600s;
    }
}

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

Pastikan batas waktu streaming proksi terbalik selaras dengan variabel lingkungan batas waktu OmniRoute. Jika Anda menaikkan FETCH_TIMEOUT_MS / STREAM_IDLE_TIMEOUT_MS, naikkan proxy_read_timeout / proxy_send_timeout hingga melampaui ambang batas yang sama.

OmniRoute menggunakan NEXT_PUBLIC_BASE_URL sebagai origin kanonis yang diakses browser untuk callback OAuth dan tautan publik yang dihasilkan. Operasi tulis dasbor yang diautentikasi menggunakan permintaan same-origin beserta perlindungan CSRF yang terikat pada sesi, sehingga tidak memerlukan URL dasar publik statis. Header X-Forwarded-* di atas tetap berguna sebagai metadata perutean, tetapi bukan pengganti pengaturan URL publik eksplisit ketika OAuth atau tautan browser yang dihasilkan memerlukannya. Hanya aktifkan OMNIROUTE_TRUST_PROXY jika OmniRoute tidak dapat dijangkau langsung oleh klien dan proksi Anda menghapus/membuat ulang header terusan yang masuk.

3.3 Aktifkan dan Uji

# Hapus konfigurasi default
rm -f /etc/nginx/sites-enabled/default

# Aktifkan OmniRoute
ln -sf /etc/nginx/sites-available/omniroute /etc/nginx/sites-enabled/omniroute

# Uji dan muat ulang
nginx -t && systemctl reload nginx

4. Konfigurasi DNS Cloudflare

4.1 Tambahkan catatan DNS

Di dasbor Cloudflare → DNS:

Jenis Nama Konten Proksi
A llms 203.0.113.10 (IP VM) ✅ Diproksikan

4.2 Konfigurasi SSL

Di bagian SSL/TLS → Overview:

  • Mode: Full (Strict)

Di bagian SSL/TLS → Edge Certificates:

  • Selalu Gunakan HTTPS: ✅ Aktif
  • Versi TLS Minimum: TLS 1.2
  • Penulisan Ulang HTTPS Otomatis: ✅ Aktif

4.3 Pengujian

curl -sI https://llms.seudominio.com/health
# Seharusnya mengembalikan HTTP/2 200

5. Operasi dan Pemeliharaan

Tingkatkan ke versi baru

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

Lihat log

docker logs -f omniroute          # Aliran waktu nyata
docker logs omniroute --tail 50   # 50 baris terakhir

Pencadangan basis data secara manual

# Salin data dari volume ke host
docker cp omniroute:/app/data ./backup-$(date +%F)

# Atau kompres seluruh volume
docker run --rm -v omniroute-data:/data -v $(pwd):/backup \
  alpine tar czf /backup/omniroute-data-$(date +%F).tar.gz /data

Pulihkan dari cadangan

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. Keamanan Tingkat Lanjut

Batasi nginx ke IP Cloudflare

cat > /etc/nginx/cloudflare-ips.conf << 'CF'
# Rentang IPv4 Cloudflare — perbarui secara berkala
# 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

Tambahkan baris berikut ke nginx.conf di dalam blok http {}:

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

Instal fail2ban

apt install -y fail2ban
systemctl enable fail2ban
systemctl start fail2ban

# Periksa status
fail2ban-client status sshd

Blokir akses langsung ke port Docker

# Cegah akses eksternal langsung ke port 20128
iptables -I DOCKER-USER -p tcp --dport 20128 -j DROP
iptables -I DOCKER-USER -i lo -p tcp --dport 20128 -j ACCEPT

# Pertahankan aturan setelah sistem dimulai ulang
apt install -y iptables-persistent
netfilter-persistent save

7. Terapkan ke Cloudflare Workers (Opsional)

Untuk akses jarak jauh melalui Cloudflare Workers (tanpa mengekspos VM secara langsung):

# Di repositori lokal
cd omnirouteCloud
npm install
npx wrangler login
npx wrangler deploy

Lihat juga TUNNELS_GUIDE.md untuk panduan langkah demi langkah Cloudflare Tunnel di dalam repositori. Worker mandiri omnirouteCloud/ berada di repositori pendamping yang terpisah.


Ringkasan Port

Port Layanan Akses
22 SSH Publik (dengan fail2ban)
80 nginx HTTP Pengalihan → HTTPS
443 nginx HTTPS Melalui Cloudflare Proxy
20128 OmniRoute Hanya localhost (via nginx)

Optimasi untuk VPS Kecil / Bermemori Rendah

Untuk deployment pada instans VPS kecil (RAM 1 GB atau kurang):

  • Nonaktifkan layanan latar belakang — tetapkan OMNIROUTE_DISABLE_BACKGROUND_SERVICES=1 untuk melewati scheduler, server MCP, dan tugas pemeliharaan berkala. Lihat docs/reference/ENVIRONMENT.md.
  • Gunakan mode WAL SQLite — diaktifkan secara default, mengurangi penggunaan memori puncak selama pembacaan serentak.
  • Batasi heap V8 — tetapkan OMNIROUTE_MEMORY_MB (misalnya 512) agar runtime tidak mengalibrasi batas maksimum yang lebih besar daripada VM. Lihat docs/reference/ENVIRONMENT.md.
  • Penerimaan beban berat diskalakan secara otomatis berdasarkan batas heap -- setelah OMNIROUTE_MEMORY_MB ditetapkan seperti di atas, anggaran byte untuk ingest (OMNIROUTE_CHAT_MAX_INFLIGHT_BYTES) diturunkan dari batas maksimum yang sama, sehingga VM dengan memori terbatas otomatis memperoleh anggaran permintaan serentak yang lebih kecil tanpa penyesuaian tambahan; permintaan berlebih akan menerima respons 503 yang dapat dicoba ulang dengan Retry-After, alih-alih bersaing memperebutkan memori. Tetapkan batas jumlah permintaan lama OMNIROUTE_CHAT_MAX_HEAVY_IN_FLIGHT hanya jika Anda memerlukan batas maksimum tegas sebagai tambahan.
  • Hindari next build di VPS — lakukan build secara lokal dan deploy output standalone (.next/standalone/).
  • Pantau dengan top / free -m — OmniRoute biasanya menggunakan RSS 200–400 MB saat idle pada VM 1 GB.