Hızlı başlangıç

nivq tek bir konteynerdir. Çalışması için bir PostgreSQL'e (pgvector eklentili) ve bir Redis/Valkey'e bağlanması, bir de saklanan kimlik bilgilerini şifreleyeceği bir anahtara ihtiyacı vardır — hepsi bu. Geri kalan her şeyin makul bir varsayılanı var.

İki yol var:

Docker Compose — Postgres ve Redis'i sizin için de ayağa kaldırır. Sıfırdan başlıyorsanız en hızlısı budur.
Tek bir docker run — elinizde zaten bir Postgres ve Redis varsa, sadece imajı çekip onlara yönlendirin.

İkisi de aynı ortam değişkenlerini okur; tek fark onları nasıl geçirdiğiniz.

İmajı çekin

nivq özel bir imaj (ghcr.io/nivorbit/images/nivq). Bir token'la giriş yapıp çekin:

Shell

echo "<token>" | docker login ghcr.io -u <kullanıcı-adı> --password-stdin
docker pull ghcr.io/nivorbit/images/nivq:1.0.0

Token'ınız yoksa Nivorbit ekibinden isteyin ya da sales@nivorbit.com'a yazın.

Registry erişimi olmayan ortamlar

Registry'ye erişimi olmayan bir ağdaysanız girişi atlayın. Nivorbit size imajı bir tarball olarak verir; onu yükleyin: docker load -i nivq-1.0.0.tar

nivq'nun okuduğu ayarlar

nivq'yu ortam değişkenleriyle yapılandırırsınız. Açılış için yalnızca şu birkaçı zorunludur:

Değişken	Ne işe yarar
`NIVQ_DATASOURCE_URL`	Postgres JDBC URL'i (`pgvector` eklentili)
`NIVQ_DATASOURCE_USERNAME` / `NIVQ_DATASOURCE_PASSWORD`	Postgres kimlik bilgileri
`NIVQ_REDIS_HOST` / `NIVQ_REDIS_PORT`	Redis/Valkey adresi
`NIVQ_ENCRYPTION_KEY_V1`	Saklanan gizleri şifreleyen 32 baytlık base64 anahtar (`openssl rand -base64 32`) — yedekleyin
`NIVQ_PLATFORM_LLM_PROVIDER` / `NIVQ_PLATFORM_LLM_API_KEY`	Hafif iç görevleri yürüten platform LLM'i
`NIVQ_BOOTSTRAP_ADMIN_USERNAME` / `NIVQ_BOOTSTRAP_ADMIN_PASSWORD`	İlk açılış için yerel yönetici girişi — IdP kurulumu gerekmez
`BACKEND_URL` / `FRONTEND_URL`	Tarayıcıdan erişilen genel URL'ler

Bu değişkenleri nasıl geçireceğiniz size kalmış — Compose için bir .env dosyası, tek konteyner için -e bayrakları, ya da bir gizli yöneticisinin enjekte ettiği değerler. Tam liste Yapılandırma'da.

Üretim modu varsayılandır

İmaj her zaman üretim modunda çalışır — yalnızca-geliştirme uç noktaları en baştan kapalıdır. Ayarlanacak bir mod ya da profil bayrağı yoktur.

Şifreleme anahtarını koruyun

NIVQ_ENCRYPTION_KEY_V1'i kaybetmek, saklanan her kimlik bilgisinin kurtarılamaz hale gelmesi demektir. Bir gizli yöneticisinde yedekleyin, asla commit etmeyin.

Yol A — Docker Compose

Sıfırdan başlıyorsanız Compose, nivq'yu iki veri deposuyla birlikte ayağa kaldırır. Bir dizin açıp şu docker-compose.yml'i koyun:

YAML

services:
  postgres:
    image: pgvector/pgvector:pg18
    environment:
      POSTGRES_DB: nivq
      POSTGRES_USER: nivq
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:?.env içinde POSTGRES_PASSWORD ayarlayin — guclu herhangi bir deger}
    volumes:
      - nivq-pg:/var/lib/postgresql
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U nivq"]
      interval: 5s
      retries: 10

  redis:
    image: redis:7-alpine
    volumes:
      - nivq-redis:/data
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 5s
      retries: 10

  nivq:
    image: ghcr.io/nivorbit/images/nivq:1.0.0
    depends_on:
      postgres: { condition: service_healthy }
      redis: { condition: service_healthy }
    env_file: .env          # ayarları buradan okur — aşağıdaki örneğe bakın
    environment:
      # Yukarıdaki POSTGRES_PASSWORD'ü yeniden kullanır — iki değil tek parola.
      NIVQ_DATASOURCE_PASSWORD: ${POSTGRES_PASSWORD}
      # Zorunlu değerler .env boş kaldığında crash-loop yerine net bir mesajla
      # hemen durur. Değerleri burada değil .env içinde doldurun.
      NIVQ_ENCRYPTION_KEY_V1: ${NIVQ_ENCRYPTION_KEY_V1:?.env icinde NIVQ_ENCRYPTION_KEY_V1 ayarlayin — openssl rand -base64 32 ile uretin}
      NIVQ_PLATFORM_LLM_API_KEY: ${NIVQ_PLATFORM_LLM_API_KEY:?.env icinde NIVQ_PLATFORM_LLM_API_KEY ayarlayin — LLM saglayici API anahtariniz}
      NIVQ_BOOTSTRAP_ADMIN_PASSWORD: ${NIVQ_BOOTSTRAP_ADMIN_PASSWORD:?.env icinde NIVQ_BOOTSTRAP_ADMIN_PASSWORD ayarlayin — ilk kurulum admin parolasi}
    ports:
      - "8080:8080"
    restart: unless-stopped

  # Tarayıcı arayüzü. API'ye yönlendirilmiş statik bir uygulama; ayrıntı için bkz. Web istemcisi.
  nivq-web:
    image: ghcr.io/nivorbit/images/nivq-web:1.0.0
    depends_on: [nivq]
    environment:
      # API URL'i, tarayıcıdan erişildiği haliyle (BACKEND_URL ile eşleşmeli).
      NIVQ_API_BASE_URL: http://localhost:8080
    ports:
      - "3000:8080"          # arayüzü FRONTEND_URL'de servis et (http://localhost:3000)
    restart: unless-stopped

volumes:
  nivq-pg:
  nivq-redis:

docker-compose.ymlYa da doğrudan indirin.

Yanına ayarları taşıyan bir .env koyun. En hızlı yol, güçlü ve benzersiz sırları sizin için üretir — geriye yalnızca LLM anahtarınızı yapıştırmak kalır:

Shell

cat > .env <<EOF
POSTGRES_PASSWORD=$(openssl rand -base64 24)
NIVQ_ENCRYPTION_KEY_V1=$(openssl rand -base64 32)
NIVQ_PLATFORM_LLM_PROVIDER=anthropic
NIVQ_PLATFORM_LLM_API_KEY=
NIVQ_BOOTSTRAP_ADMIN_USERNAME=admin@example.com
NIVQ_BOOTSTRAP_ADMIN_PASSWORD=$(openssl rand -base64 18)
BACKEND_URL=http://localhost:8080
FRONTEND_URL=http://localhost:3000
NIVQ_DATASOURCE_URL=jdbc:postgresql://postgres:5432/nivq
NIVQ_DATASOURCE_USERNAME=nivq
NIVQ_REDIS_HOST=redis
NIVQ_REDIS_PORT=6379
EOF

Ardından iki şey: sağlayıcı anahtarınızı NIVQ_PLATFORM_LLM_API_KEY alanına yapıştırın (bilerek boş bırakıldı — siz doldurana kadar başlangıç net bir mesajla durur) ve üretilen admin parolasını grep NIVQ_BOOTSTRAP_ADMIN_PASSWORD .env ile not alın. NIVQ_ENCRYPTION_KEY_V1'i yedekleyin — kaybolursa saklanan tüm kimlik bilgileri geri alınamaz.

Bu değerleri kurulumlar arasında tekrar kullanmayın ve sürüm kontrolüne göndermeyin. Her ortam kendi taze üretilmiş sırlarını alır.

Elle doldurmayı mı tercih edersiniz? Her ayar, açıklamasıyla:

Shell

# NivQ ayarları — "Zorunlu" başlığı altındaki her boş değeri doldurun.
# Değerler ayarlanana kadar `docker compose up` net bir mesajla başlamayı reddeder.

# ── Zorunlu ──────────────────────────────────────────────────────────────────

# Pakete dahil Postgres'in parolası — NivQ da aynı değerle bağlanır.
# Güçlü herhangi bir değer; bir kez seçin (sonradan değiştirmek DB volume sıfırlamayı gerektirir).
POSTGRES_PASSWORD=

# Zorunlu — NivQ'nun sakladığı kimlik bilgilerini şifreleyen 32 baytlık base64 anahtar.
# Bir tane üretip aşağıdaki = işaretinden sonra yapıştırın:  openssl rand -base64 32
# (Ya da Hızlı Başlangıç'taki tek-komut .env üretecini kullanın; bunu sizin için doldurur.)
# Yedekleyin — bu anahtar kaybolursa saklanan hiçbir kimlik bilgisi kurtarılamaz.
NIVQ_ENCRYPTION_KEY_V1=

# İç görevleri çalıştıran ve Enterprise dışı tüm planlara hizmet eden platform LLM'i.
# Provider ve model opsiyonel: boş bırakılırsa aşağıdaki varsayılanlar kullanılır.
# Değiştirmek için satırın yorumunu kaldırın — boş bir değer varsayılanı ezer
# (ve açılışı durdurur), o yüzden boş bırakmayın.
# NIVQ_PLATFORM_LLM_PROVIDER=anthropic
# NIVQ_PLATFORM_LLM_MODEL=claude-haiku-4-5-20251001
NIVQ_PLATFORM_LLM_API_KEY=

# Web arayüzü için ilk kurulum admin girişi (kullanıcı adı bir e-posta olmalı).
# Gerçek SSO'nuzu sonra bağlayın — bkz. Kimlik doğrulama dokümanı.
NIVQ_BOOTSTRAP_ADMIN_USERNAME=admin@example.com
NIVQ_BOOTSTRAP_ADMIN_PASSWORD=

# ── Genel URL'ler ────────────────────────────────────────────────────────────

# Tarayıcıdan erişildiği haliyle. localhost varsayılanları tek makinede deneme
# için yeterli; üretimde gerçek alan adlarınızı yazın (örn. https://nivq-api.acme.com).
# Not: BACKEND_URL'in host kısmı, domain'e bağlı lisansın düzenlendiği alan adıdır —
# lisans talep ederken bu değeri Nivorbit ile paylaşacaksınız.
BACKEND_URL=http://localhost:8080
FRONTEND_URL=http://localhost:3000

# ── Paketteki compose dosyasına bağlı (olduğu gibi bırakın) ──────────────────

NIVQ_DATASOURCE_URL=jdbc:postgresql://postgres:5432/nivq
NIVQ_DATASOURCE_USERNAME=nivq
NIVQ_REDIS_HOST=redis
NIVQ_REDIS_PORT=6379

nivq.envnivq.env adıyla iner — .env olarak yeniden adlandırıp değerleri doldurun.

Yalnızca Zorunlu başlığı altındaki değerlerin düzenlenmesi gerekir. Biri boş kalırsa docker compose up, değişkenin adını söyleyen bir mesajla başlamayı reddeder — sessiz crash-loop yok.

Kaldırın:

Shell

docker compose up -d
docker compose logs -f nivq

İlk açılış veritabanı göçlerini çalıştırır; birkaç saniye tanıyın. Arayüz http://localhost:3000 adresinde açılır — nasıl yapılandırıldığı ve girişin nasıl bağlandığı için bkz. Web istemcisi.

Yol B — Tek bir `docker run`

Zaten bir Postgres (pgvector eklentili) ve Redis'iniz varsa imajı doğrudan çalıştırıp onlara yönlendirin. Ayarlar .env yerine -e bayraklarıyla gelir:

Shell

docker run -d --name nivq -p 8080:8080 \
  -e NIVQ_DATASOURCE_URL=jdbc:postgresql://my-postgres:5432/nivq \
  -e NIVQ_DATASOURCE_USERNAME=nivq \
  -e NIVQ_DATASOURCE_PASSWORD=guclu-bir-deger \
  -e NIVQ_REDIS_HOST=my-redis -e NIVQ_REDIS_PORT=6379 \
  -e NIVQ_ENCRYPTION_KEY_V1="$(openssl rand -base64 32)" \
  -e NIVQ_PLATFORM_LLM_PROVIDER=anthropic -e NIVQ_PLATFORM_LLM_API_KEY=sk-... \
  -e NIVQ_BOOTSTRAP_ADMIN_USERNAME=admin@example.com \
  -e NIVQ_BOOTSTRAP_ADMIN_PASSWORD=uzun-bir-parola \
  -e BACKEND_URL=http://localhost:8080 -e FRONTEND_URL=http://localhost:3000 \
  ghcr.io/nivorbit/images/nivq:1.0.0

Bir dosyada toplamayı tercih ederseniz aynısını --env-file ortam.env ile de geçirebilirsiniz.

Sonra arayüz konteynerini de API'ye yönlendirerek yanında çalıştırın:

Shell

docker run -d --name nivq-web -p 3000:8080 \
  -e NIVQ_API_BASE_URL=http://localhost:8080 \
  ghcr.io/nivorbit/images/nivq-web:1.0.0

Ayakta mı, kontrol edin

Shell

curl http://localhost:8080/actuator/health
# {"status":"UP"}

Lisansı etkinleştirin

nivq activation-pending açılır — ayakta, ama giriş ve lisans uç noktaları dışında kilitli. Lisans veritabanına kaydedilir, yani bu tek seferlik bir adım.

En kolay yol: arayüzü http://localhost:3000 adresinde açın. İlk açılış etkinleştirme ekranı kurulum kimliğinizi gösterir ve Nivorbit ile paylaş düğmesi göndermeye hazır bir lisans talebi e-postası açar.

Terminali mi tercih ediyorsunuz? Kurulum kimliğini okuyun:

Shell

curl http://localhost:8080/v1/license/fingerprint
# → {"fingerprint":"NIVQ-FP-XXXXX-XXXXX-XXXXX-XXXXX","backendHost":"api.acme.com"}

Her iki değeri support@nivorbit.com adresine gönderin — bağlantı hazır doldurulmuş bir talep açar. fingerprint bu makineyi tanımlar; backendHost ise BACKEND_URL'inizin host kısmıdır — domain'e bağlı lisans bu alan adı için düzenlenir.

Shell

# Nivorbit license.jwt'yi döndürünce yükleyin — yeniden başlatma gerekmez
curl -F "file=@license.jwt" http://localhost:8080/v1/license/upload

Makineye bağlama, domain'e bağlama ve internet çıkışı olmayan akışlar dahil ayrıntılar Lisanslama ve etkinleştirme'de.

Hazırsınız

nivq'yu http://localhost:3000 adresinde açın, .env'deki bootstrap admin bilgileriyle giriş yapın, ilk çalışma alanınızı oluşturun, sonra veritabanlarınızdan birine bağlı bir ajan ekleyin. Artık verinize soru sorabilirsiniz.

Gerçek girişi hazır olunca bağlayın

Bootstrap admin bir ilk açılış hesabıdır. Ekibiniz için Kimlik doğrulama'daki gibi Google, Microsoft, GitHub ya da herhangi bir OIDC sağlayıcısı yapılandırın — sonra iki bootstrap değişkenini kaldırın (ya da acil durum girişi olarak saklayın).

Sonraki adımlar

Tüm ayarları Yapılandırma'da görün, üretim için Üretim sertleştirme'de sağlamlaştırın, ya da bir Kubernetes kümesine kuruyorsanız Kubernetes (Helm)'e geçin.

İmajı çekin

nivq'nun okuduğu ayarlar

Yol A — Docker Compose

Yol B — Tek bir docker run

Ayakta mı, kontrol edin

Lisansı etkinleştirin

Hazırsınız

Yol B — Tek bir `docker run`