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:0.2.4

Token'ınız yoksa Nivorbit ekibinden isteyin ya da [email protected]'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-0.2.4.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}
    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:0.2.4
    depends_on:
      postgres: { condition: service_healthy }
      redis: { condition: service_healthy }
    env_file: .env          # ayarları buradan okur — aşağıdaki örneğe bakın
    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:0.2.2
    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:

Shell

POSTGRES_PASSWORD=guclu-bir-deger
NIVQ_DATASOURCE_URL=jdbc:postgresql://postgres:5432/nivq
NIVQ_DATASOURCE_USERNAME=nivq
NIVQ_DATASOURCE_PASSWORD=guclu-bir-deger
NIVQ_REDIS_HOST=redis
NIVQ_REDIS_PORT=6379

NIVQ_ENCRYPTION_KEY_V1=buraya-base64-32-bayt   # openssl rand -base64 32

NIVQ_PLATFORM_LLM_PROVIDER=anthropic
NIVQ_PLATFORM_LLM_API_KEY=sk-...

NIVQ_BOOTSTRAP_ADMIN_USERNAME=admin@example.com   # bir e-posta olmalı
NIVQ_BOOTSTRAP_ADMIN_PASSWORD=uzun-bir-parola

BACKEND_URL=http://localhost:8080
FRONTEND_URL=http://localhost:3000

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

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:0.2.4

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:0.2.2

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. Sunucu parmak izini okuyup lisansı yükleyin; lisans veritabanına kaydedilir, yani bu tek seferlik bir adım:

Shell

# Nivorbit'e göndereceğiniz dağıtım parmak izi (makineye bağlı lisans için)
curl http://localhost:8080/v1/license/fingerprint
#  → NIVQ-FP-XXXXX-XXXXX-XXXXX-XXXXX

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

Makineye 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`