LibreChat Yönetici Paneli

LibreChat Yönetim Paneli, LibreChat için tarayıcı tabanlı bağımsız bir yönetim arayüzüdür. LibreChat'in kendisiyle aynı veritabanına bağlanır ve ayrıntılı erişim denetimini destekleyen idari görevler için bir grafik kullanıcı arayüzü (GUI) sağlar: kullanıcı ve grup yönetimi, rol yönetimi, rol veya gruplara göre kapsamlandırılmış yapılandırma geçersiz kılmaları ve sistem düzeyinde yetki tanımlamaları.

Ne İşe Yarar

Yönetici paneli ince bir istemcidir: tüm veriler LibreChat veritabanında bulunur ve her işlem LibreChat API sunucusundaki sürümlü /api/admin/* endpoint'leri üzerinden gerçekleşir. Yöneticilere aşağıdakileri yapabilecekleri tek bir yer sağlar:

• Yapılandırmayı yönetin: Her bir LibreChat ayarını dinamik, şema tabanlı bir form aracılığıyla görüntüleyin ve düzenleyin. Yapılandırma şemasına eklenen yeni alanlar otomatik olarak görünür, yönetici paneli sürümü gerektirmez.
• İlke bazlı geçersiz kılmaları uygula: Yapılandırma geçersiz kılmalarını belirli rollere veya gruplara göre kapsamlandırın; her kullanıcının giriş yaptığında gördüğü nihai çözümlenmiş değeri belirleyen öncelik tabanlı bir kademeli yapı kullanın.
• Kullanıcıları yönetin: örnek üzerindeki her hesabı listeleyin, arayın ve görüntüleyin.
• Grupları yönetin: grup oluşturun ve silin, üye ekleyin/çıkarın ve grupları ACL'lerde ve geçersiz kılmalarda (overrides) birinci sınıf özneler olarak kullanın.
• Rolleri yönetin: yerleşik USER / ADMIN dışında özel roller oluşturun, bunların özellik-izin matrisini düzenleyin ve kullanıcılara roller atayın.
• Sorun sistemi yetkilendirmeleri: Belirli kullanıcılara, gruplara veya rollere, onları tam yönetici yapmadan yönetici yetenekleri (örneğin manage:users, read:usage, manage:mcpservers) atayın.
• Kimlik Doğrulama: Yerel bir LibreChat yönetici hesabı ile veya LibreChat örneğinde etkinleştirilmişse OpenID SSO / SAML / desteklenen OAuth sağlayıcıları aracılığıyla giriş yapın.

Temel izin modeli (sorumlular, kaynak ACL'leri, yetenekler ve katmanların nasıl oluşturulduğu) için Access Control sayfasına bakın.

Mimari

┌──────────────────┐         ┌──────────────────┐         ┌──────────────┐
│  Admin Panel     │ ───────▶│  LibreChat API   │ ───────▶│   MongoDB    │
│  (Bun + Vite)    │  HTTPS  │  /api/admin/*    │         │  (shared DB) │
└──────────────────┘         └──────────────────┘         └──────────────┘
       │                             │
       │ OAuth/OIDC/SAML redirect    │ Verifies admin access
       └─────────────────────────────┘

Yönetici paneli ayrı bir servis olarak çalışır; LibreChat ile aynı süreci paylaşmaz. Yönetici yetenekleri, LibreChat tarafında access:admin sistem izni veya SystemRoles.ADMIN rolü aracılığıyla doğrulanır, bu nedenle panel kendisine sahip olmaması gereken ayrıcalıkları tanıyamaz.

LibreChat tarafından sunulan yönetici API yüzeyi şöyledir:

Başlarken

Ön Koşullar

• v0.8.5 veya üzeri bir sürümde çalışan bir LibreChat örneği (yönetici API'leri önceki sürümlerde mevcut değildir)
• admin-panel kapsayıcısından/ana bilgisayarından LibreChat API'sine ağ erişimi
• LibreChat üzerinde bir yönetici hesabı: ya ilk kayıt olan kullanıcı (otomatik yönetici), Mongo'da role: 'ADMIN' olarak ayarlanmış bir kullanıcı ya da access:admin yetkisi verilmiş bir yönetici.

LibreChat ile birlikte gelir (önerilen)

LibreChat'i resmi docker-compose.yml veya deploy-compose.yml dosyalarıyla çalıştırırsanız, yönetici paneli bir servis olarak gelir ve LibreChat ile birlikte otomatik olarak başlar; ayrı bir dağıtım gerekmez.

Yığını başlatmadan önce LibreChat'in .env dosyasında panelin oturum gizli anahtarını (session secret) ayarlayın; compose dosyaları bunu panelin SESSION_SECRET değeri olarak aktarır:

# Min 32 characters. Generate with: openssl rand -hex 32
ADMIN_PANEL_SESSION_SECRET=replace-with-a-32-char-random-string

# Optional: host port for the default docker-compose
# ADMIN_PANEL_PORT=3000

# Optional: set true when the panel is served over HTTPS
# ADMIN_PANEL_SESSION_COOKIE_SECURE=false

Compose dosyaları geri kalanını otomatik olarak bağlar: API_SERVER_URL, api servisini işaret eder; VITE_API_BASE_URL, tarayıcı tabanlı OAuth yönlendirmeleri için DOMAIN_CLIENT değerini takip eder ve ADMIN_PANEL_URL, LibreChat'in SSO sonrası yöneticileri panele geri yönlendirmesi için ayarlanır. Bu özelliği devre dışı bırakmak için admin-panel servisini kaldırın veya bir Compose profiles girdisi ile sınırlandırın.

Standalone (ayrı dağıtım)

Yönetim panelini kendi başına barındırmak ve başka bir yerde çalışan bir LibreChat örneğine yönlendirmek için GHCR'den yayınlanan görüntüyü kullanın:

# 1. Create an env file
cp .env.example .env

# 2. Edit .env and set at minimum:
#    SESSION_SECRET=<random string, min 32 characters>
#    VITE_API_BASE_URL=http://host.docker.internal:3080

# 3. Start it
docker compose up -d   # http://localhost:3000
docker compose down    # stop

Bağımsız docker run:

docker run -p 3000:3000 \
  --add-host=host.docker.internal:host-gateway \
  -e SESSION_SECRET=replace-with-32-char-random-string \
  -e VITE_API_BASE_URL=http://host.docker.internal:3080 \
  ghcr.io/clickhouse/librechat-admin-panel:latest

Geliştirme için Yerel Olarak Çalıştırma

git clone https://github.com/ClickHouse/librechat-admin-panel.git
cd librechat-admin-panel
cp .env.example .env    # then edit
bun install
bun dev                 # http://localhost:3000

Ortam Değişkenleri

LibreChat'in paketlenmiş Docker yığınlarında, admin paneli bir admin-panel servisi olarak çalışır. Varsayılan docker-compose.yml dosyası bunu ADMIN_PANEL_PORT üzerinde dışa aktarır; deploy-compose.yml ise bunu nginx üzerinden http://admin.localhost adresine yönlendirir ve API servisi için ADMIN_PANEL_URL değerini ayarlar.

LibreChat Yönlendirme URL'si

Yönetici paneli LibreChat'ten ayrı bir URL'de barındırıldığında, LibreChat API ortamında ADMIN_PANEL_URL ayarını yapın. Herhangi bir yol öneki dahil olmak üzere harici yönetici paneli temel URL'sini kullanın ve sondaki eğik çizgiyi (slash) kaldırın:

ADMIN_PANEL_URL=https://admin.example.com/admin

Helm dağıtımları için, values dosyanızda librechat.adminPanelUrl değerini ayarlayın. Chart, bunu LibreChat'in yönetici OAuth akışı için ADMIN_PANEL_URL olarak işler:

librechat:
  adminPanelUrl: https://admin.example.com/admin

OpenID SSO için, ${DOMAIN_SERVER}/api/admin/oauth/openid/callback adresini kimlik sağlayıcınızla kaydedin.

Önbellek Kontrolleri

Bunlar LibreChat'in önbellek env var'larını yansıtır. ADMIN_PANEL_* varyantları önceliklidir; ayarlanmadıklarında paylaşılan LibreChat karşılıklarına geri dönülür.

Kimlik Doğrulama

Yönetici paneli, LibreChat'in kimlik doğrulama yığınını yeniden kullanır ve kendine ait bir kullanıcı veritabanına sahip değildir. İki giriş yolu desteklenmektedir:

• Yerel hesaplar: hesapları yönetici erişimi denetiminden geçen herhangi bir LibreChat kullanıcısına karşı kullanıcı adı/parola.
• Tek oturum açma (SSO): OpenID Connect, SAML ve LibreChat örneğinizde halihazırda yapılandırılmış olan sosyal OAuth sağlayıcıları. Parola formunu tamamen gizlemek için ADMIN_SSO_ONLY=true olarak ayarlayın.

LibreChat tarafından her istek için yönetici erişimi sunucu tarafında doğrulanır. Hesabın şunlardan birine sahip olması gerekir:

1. MongoDB'de role: 'ADMIN' değerine sahip olun veya
2. access:admin sistem yetkisine sahip olun (yönetim paneli aracılığıyla başka bir kullanıcıya atanır; bkz. System Grants).

Oturumlar çerez tabanlıdır, SESSION_SECRET ile şifrelenir ve ADMIN_SESSION_IDLE_TIMEOUT_MS değerine göre boşta kalma süresi sonunda sona erer.

Yapılandırma Yönetimi

Panel, LibreChat yapılandırmasını yapılandırma şeması tarafından yönlendirilen dinamik bir form olarak oluşturur. Bunun iki yararlı özelliği vardır:

• Geriye dönük uyumlu: LibreChat yeni bir yapılandırma alanı sunduğunda, panel bunu şemadan otomatik olarak alır. Yönetici paneli yükseltmesi veya yeniden dağıtım gerekmez.
• Katmanlı geçersiz kılmalar (Layered overrides): temel yapılandırma (librechat.yaml dosyasından gelen), bir role veya gruba kapsamlanmış, yönetici bazlı geçersiz kılmalar ile gölgelenebilir. Bir kullanıcı giriş yaptığında, geçersiz kılmalar öncelik sırasına göre çözümlenir ve kullanıcının gördüğü etkin yapılandırmayı oluşturmak için temel yapılandırmanın üzerine birleştirilir.

Bu, LibreChat'in DB-backed per-principal configuration override system özelliğinin arkasındaki arayüzdür. Tipik kullanım durumları:

• Bir "Research" grubuna daha yüksek bir recursionLimit ve ek endpoint'ler verin
• "FinanceAdmins" rolünün MCP sunucularını yönetmesine izin verin, normal kullanıcılar ise bunları yalnızca kullanabilsin
• interface izinlerini harici yüklenici grupları için daha katı olacak şekilde sınırlandırın

İlgili

• Access Control: yönetici panelinin üzerine inşa edildiği izin modeli
• Arayüz Yapılandırması: panelin düzenlediği özellik bayrakları
• Authentication: LibreChat üzerinde kullanıcı kimlik doğrulaması
• v0.8.5 sürüm notları: admin API temelleri
• GitHub: ClickHouse/librechat-admin-panel: kaynak, sorunlar, sürümler