Gateway
Gateway operasyon kılavuzu
Bu sayfayı Gateway hizmetinin 1. gün başlatması ve 2. gün operasyonları için kullanın.
Kesin komut basamakları ve günlük imzalarıyla belirti odaklı tanılama.
Görev odaklı kurulum kılavuzu + tam yapılandırma başvurusu.
SecretRef sözleşmesi, çalışma zamanı anlık görüntü davranışı ve migrate/reload işlemleri.
Kesin secrets apply hedef/yol kuralları ve yalnızca ref auth-profile davranışı.
5 dakikalık yerel başlatma
Gateway’i başlat
OmeniaClaw gateway --port 18789# debug/trace mirrored to stdioOmeniaClaw gateway --port 18789 --verbose# force-kill listener on selected port, then startOmeniaClaw gateway --forceHizmet sağlığını doğrula
OmeniaClaw gateway statusOmeniaClaw statusOmeniaClaw logs --followSağlıklı temel durum: Beklediğinizle eşleşen Runtime: running, Connectivity probe: ok ve Capability: .... Yalnızca erişilebilirlik değil, okuma kapsamlı RPC kanıtı gerektiğinde OmeniaClaw gateway status --require-rpc kullanın.
Kanal hazır olma durumunu doğrula
OmeniaClaw channels status --probeErişilebilir bir Gateway ile bu, hesap başına canlı kanal yoklamaları ve isteğe bağlı denetimler çalıştırır. Gateway erişilemezse CLI, canlı yoklama çıktısı yerine yalnızca yapılandırmaya dayalı kanal özetlerine geri döner.
Çalışma zamanı modeli
- Yönlendirme, denetim düzlemi ve kanal bağlantıları için sürekli açık tek süreç.
- Şunlar için tek çoğullamalı port:
- WebSocket denetimi/RPC
- HTTP API’leri, OpenAI uyumlu (
/v1/models,/v1/embeddings,/v1/chat/completions,/v1/responses,/tools/invoke) - Denetim kullanıcı arayüzü ve hook’lar
- Varsayılan bağlama modu:
loopback. - Kimlik doğrulama varsayılan olarak gereklidir. Paylaşılan gizli bilgi kurulumları
gateway.auth.token/gateway.auth.password(veyaOmeniaClaw_GATEWAY_TOKEN/OmeniaClaw_GATEWAY_PASSWORD) kullanır ve local loopback olmayan ters proxy kurulumlarıgateway.auth.mode: "trusted-proxy"kullanabilir.
OpenAI uyumlu uç noktalar
OmeniaClaw’ın en yüksek getirili uyumluluk yüzeyi artık şudur:
GET /v1/modelsGET /v1/models/{id}POST /v1/embeddingsPOST /v1/chat/completionsPOST /v1/responses
Bu kümenin neden önemli olduğu:
- Çoğu Open WebUI, LobeChat ve LibreChat entegrasyonu önce
/v1/modelsyoklar. - Birçok RAG ve bellek hattı
/v1/embeddingsbekler. - Ajan yerel istemciler giderek daha fazla
/v1/responsestercih eder.
Planlama notu:
/v1/modelsajan önceliklidir:OmeniaClaw,OmeniaClaw/defaultveOmeniaClaw/<agentId>döndürür.OmeniaClaw/default, her zaman yapılandırılmış varsayılan ajana eşlenen kararlı takma addır.- Bir arka uç sağlayıcı/model geçersiz kılması istediğinizde
x-OmeniaClaw-modelkullanın; aksi halde seçilen ajanın normal model ve embedding kurulumu denetimde kalır.
Bunların tümü ana Gateway portunda çalışır ve Gateway HTTP API’sinin geri kalanıyla aynı güvenilir operatör kimlik doğrulama sınırını kullanır.
Port ve bağlama önceliği
| Ayar | Çözümleme sırası |
|---|---|
| Gateway portu | --port → OmeniaClaw_GATEWAY_PORT → gateway.port → 18789 |
| Bağlama modu | CLI/geçersiz kılma → gateway.bind → loopback |
Kurulu Gateway hizmetleri çözümlenen --port değerini gözetmen metaverisine kaydeder. gateway.port değiştirildikten sonra launchd/systemd/schtasks süreci yeni portta başlatsın diye OmeniaClaw doctor --fix veya OmeniaClaw gateway install --force çalıştırın.
Gateway başlatması, local loopback olmayan bağlamalar için yerel Denetim kullanıcı arayüzü origin’lerini tohumlarken aynı etkin portu ve bağlamayı kullanır. Örneğin, --bind lan --port 3000, çalışma zamanı doğrulaması çalışmadan önce http://localhost:3000 ve http://127.0.0.1:3000 değerlerini tohumlar. HTTPS proxy URL’leri gibi uzak tarayıcı origin’lerini gateway.controlUi.allowedOrigins içine açıkça ekleyin.
Sıcak yeniden yükleme modları
gateway.reload.mode |
Davranış |
|---|---|
off |
Yapılandırma yeniden yüklemesi yok |
hot |
Yalnızca sıcak-güvenli değişiklikleri uygula |
restart |
Yeniden yükleme gerektiren değişikliklerde yeniden başlat |
hybrid (varsayılan) |
Güvenliyse sıcak uygula, gerektiğinde yeniden başlat |
Operatör komut kümesi
OmeniaClaw gateway statusOmeniaClaw gateway status --deep # adds a system-level service scanOmeniaClaw gateway status --jsonOmeniaClaw gateway installOmeniaClaw gateway restartOmeniaClaw gateway stopOmeniaClaw secrets reloadOmeniaClaw logs --followOmeniaClaw doctorgateway status --deep, daha derin bir RPC sağlık yoklaması için değil, ek hizmet keşfi (LaunchDaemons/systemd sistem birimleri/schtasks) içindir.
Birden fazla Gateway (aynı ana makine)
Çoğu kurulum makine başına bir Gateway çalıştırmalıdır. Tek bir Gateway birden fazla ajan ve kanalı barındırabilir.
Yalnızca bilinçli olarak yalıtım veya kurtarma botu istediğinizde birden fazla Gateway gerekir.
Yararlı denetimler:
OmeniaClaw gateway status --deepOmeniaClaw gateway probeBeklenecekler:
gateway status --deep, eski launchd/systemd/schtasks kurulumları hâlâ duruyorsaOther gateway-like services detected (best effort)bildirebilir ve temizlik ipuçları yazdırabilir.- Birden fazla hedef yanıt verdiğinde
gateway probe,multiple reachable gatewayshakkında uyarabilir. - Bu bilinçliyse portları, yapılandırma/durumu ve çalışma alanı köklerini Gateway başına yalıtın.
Örnek başına kontrol listesi:
- Benzersiz
gateway.port - Benzersiz
OmeniaClaw_CONFIG_PATH - Benzersiz
OmeniaClaw_STATE_DIR - Benzersiz
agents.defaults.workspace
Örnek:
OmeniaClaw_CONFIG_PATH=~/.OmeniaClaw/a.json OmeniaClaw_STATE_DIR=~/.OmeniaClaw-a OmeniaClaw gateway --port 19001OmeniaClaw_CONFIG_PATH=~/.OmeniaClaw/b.json OmeniaClaw_STATE_DIR=~/.OmeniaClaw-b OmeniaClaw gateway --port 19002Ayrıntılı kurulum: /gateway/multiple-gateways.
Uzak erişim
Tercih edilen: Tailscale/VPN. Geri dönüş: SSH tüneli.
ssh -N -L 18789:127.0.0.1:18789 user@hostArdından istemcileri yerel olarak ws://127.0.0.1:18789 adresine bağlayın.
Bkz.: Uzak Gateway, Kimlik doğrulama, Tailscale.
Gözetim ve hizmet yaşam döngüsü
Üretim benzeri güvenilirlik için gözetimli çalıştırmaları kullanın.
macOS (launchd)
OmeniaClaw gateway installOmeniaClaw gateway statusOmeniaClaw gateway restartOmeniaClaw gateway stopYeniden başlatmalar için OmeniaClaw gateway restart kullanın. Yeniden başlatma yerine OmeniaClaw gateway stop ve OmeniaClaw gateway start komutlarını zincirlemeyin.
macOS’ta gateway stop varsayılan olarak launchctl bootout kullanır; bu, kalıcı bir devre dışı bırakma yapmadan LaunchAgent’ı geçerli önyükleme oturumundan kaldırır, böylece KeepAlive otomatik kurtarması beklenmeyen çökmelerden sonra hâlâ çalışır ve gateway start temiz biçimde yeniden etkinleştirir. Yeniden başlatmalar arasında otomatik yeniden doğmayı kalıcı olarak bastırmak için --disable geçirin: OmeniaClaw gateway stop --disable.
LaunchAgent etiketleri ai.OmeniaClaw.gateway (varsayılan) veya ai.OmeniaClaw.<profile> (adlandırılmış profil) şeklindedir. OmeniaClaw doctor hizmet yapılandırması sapmasını denetler ve onarır.
Linux (systemd kullanıcı)
OmeniaClaw gateway installsystemctl --user enable --now OmeniaClaw-gateway[-<profile>].serviceOmeniaClaw gateway statusOturum kapattıktan sonra kalıcılık için lingering’i etkinleştirin:
sudo loginctl enable-linger <user>Özel kurulum yolu gerektiğinde manuel kullanıcı birimi örneği:
[Unit]Description=OmeniaClaw GatewayAfter=network-online.targetWants=network-online.target [Service]ExecStart=/usr/local/bin/OmeniaClaw gateway --port 18789Restart=alwaysRestartSec=5TimeoutStopSec=30TimeoutStartSec=30SuccessExitStatus=0 143KillMode=control-group [Install]WantedBy=default.targetWindows (yerel)
OmeniaClaw gateway installOmeniaClaw gateway status --jsonOmeniaClaw gateway restartOmeniaClaw gateway stopYerel Windows yönetimli başlangıcı OmeniaClaw Gateway adlı bir Zamanlanmış Görev kullanır (veya adlandırılmış profiller için OmeniaClaw Gateway (<profile>)). Zamanlanmış Görev oluşturma reddedilirse OmeniaClaw, durum dizini içindeki gateway.cmd dosyasını işaret eden kullanıcı başına Başlangıç klasörü başlatıcısına geri döner.
Linux (sistem hizmeti)
Çok kullanıcılı/sürekli açık ana makineler için bir sistem birimi kullanın.
sudo systemctl daemon-reloadsudo systemctl enable --now OmeniaClaw-gateway[-<profile>].serviceKullanıcı birimiyle aynı hizmet gövdesini kullanın, ancak bunu /etc/systemd/system/OmeniaClaw-gateway[-<profile>].service altına kurun ve OmeniaClaw ikiliniz başka bir yerdeyse ExecStart= değerini ayarlayın.
Aynı profil/port için OmeniaClaw doctor --fix komutunun ayrıca kullanıcı düzeyinde bir Gateway hizmeti kurmasına izin vermeyin. Doctor, sistem düzeyinde bir OmeniaClaw Gateway hizmeti bulduğunda bu otomatik kurulumu reddeder; yaşam döngüsünün sahibi sistem birimiyse OmeniaClaw_SERVICE_REPAIR_POLICY=external kullanın.
Geliştirme profili hızlı yolu
OmeniaClaw --dev setupOmeniaClaw --dev gateway --allow-unconfiguredOmeniaClaw --dev statusVarsayılanlar yalıtılmış durum/yapılandırma ve temel Gateway portu 19001 içerir.
Protokol hızlı başvurusu (operatör görünümü)
- İlk istemci karesi
connectolmalıdır. - Gateway
hello-okanlık görüntüsünü döndürür (presence,health,stateVersion,uptimeMs, sınırlar/politika). hello-ok.features.methods/events, çağrılabilir her yardımcı rotanın üretilmiş dökümü değil, temkinli bir keşif listesidir.- İstekler:
req(method, params)→res(ok/payload|error). - Yaygın olaylar arasında
connect.challenge,agent,chat,session.message,session.tool,sessions.changed,presence,tick,health,heartbeat, eşleştirme/onay yaşam döngüsü olayları veshutdownbulunur.
Ajan çalıştırmaları iki aşamalıdır:
- Anında kabul edildi onayı (
status:"accepted") - Arada akışla gelen
agentolaylarıyla nihai tamamlama yanıtı (status:"ok"|"error").
Tam protokol belgelerine bakın: Gateway Protokolü.
Operasyonel denetimler
Canlılık
- WS açın ve
connectgönderin. - Anlık görüntü içeren
hello-okyanıtı bekleyin.
Hazır olma
OmeniaClaw gateway statusOmeniaClaw channels status --probeOmeniaClaw healthBoşluk kurtarma
Olaylar yeniden oynatılmaz. Sıra boşluklarında devam etmeden önce durumu yenileyin (health, system-presence).
Yaygın hata imzaları
| İmza | Olası sorun |
|---|---|
refusing to bind gateway ... without auth |
Geçerli bir Gateway kimlik doğrulama yolu olmadan loopback dışı bağlama |
another gateway instance is already listening / EADDRINUSE |
Bağlantı noktası çakışması |
Gateway start blocked: set gateway.mode=local |
Yapılandırma uzak moda ayarlanmış veya hasarlı bir yapılandırmada yerel mod damgası eksik |
unauthorized sırasında connect |
İstemci ile Gateway arasında kimlik doğrulama uyuşmazlığı |
Tam tanılama merdivenleri için Gateway Sorun Giderme sayfasını kullanın.
Güvenlik garantileri
- Gateway kullanılamadığında Gateway protokol istemcileri hızla başarısız olur (örtük doğrudan kanal yedeği yoktur).
- Geçersiz/bağlanmayan ilk çerçeveler reddedilir ve kapatılır.
- Zarif kapatma, soket kapanmadan önce
shutdownolayını yayar.
İlgili: