Ortam değişkenleri

Üç openplate konteynerinin her ayarı bir ortam değişkenidir. Bu sayfa uygulama, çekirdek sunucu (openplate-core) ve çıkarım servisi için bunların tümünü listeler. Çoğu isteğe bağlıdır. Birini ayarlanmamış bıraktığında, satırındaki varsayılan değer geçerli olur.

Bazı ayarlar başlatmayı kasten durdurur. Hizmetin kullanamadığı bir değer ya da bir ikilinin tek tarafı kapsayıcının kapanmasına neden olur. Çıkış iletisi değişkenin adını belirtir. Kapsayıcı bir tahminle başlamaz. Başlatmayı durduran ayarlar bu tür tüm kuralları listeler.

Bir değişkeni ayarlama

• Docker Compose. İlgili satırı compose dosyasının yanındaki .env dosyasına ekle, örneğin LOG_LEVEL=debug. Ardından docker compose -f <your file> up -d komutunu tekrar çalıştır. Dağıtılan her compose dosyası, hizmetinin okuduğu her değişkeni kapsayıcıya aktarır. docker compose restart, .env dosyasını tekrar okumaz.
• Quadlet. İlgili satırı birimin yanındaki <unit>.env dosyasına ekle, örneğin app.env, core.env veya inference.env. Kapsayıcının bu sayfadaki kendi adlarını kullan. Ardından birimi yeniden başlat, örneğin systemctl --user restart core.service. podman.md dosyaları açıklar.
• Kapsayıcı olmadan. Uygulama ve çekirdek sunucunun her biri, çalıştıkları klasördeki bir .env dosyasını okur. Değişkeni kabukta veya systemd biriminde de ayarlayabilirsin. Docker olmadan, uygulamanın kurulumunu gösterir.

Varsayılan sütunu, değişken ayarlanmadığında hizmetin ne yaptığını belirtir. Bir compose dosyası kendi değerini aktarabilir, örneğin MODEL_PROFILE: lite. Compose dosyası bu değeri adın yanında gösterir.

Compose dosyalarının senin yerine doldurduğu adlar

Üç topoloji dosyası (compose.core.yml, compose.inference.yml ve compose.full.yml), bazı kapsayıcı değişkenlerini .env içindeki paylaşılan adlardan doldurur. Paylaşılan adı orada ayarla. Bu dosyalarda kapsayıcı değişkeninin tek başına hiçbir etkisi yoktur.

Tek başına uygulama olan docker/compose.yml, kendi adı altında APP_URL değerini alır. Çekirdek sunucunun kendi hızlı başlangıç dosyası apps/core/docker/compose.yml şeklindedir. Kendi adları altında SERVER_PUBLIC_URL ve CLIENT_BASE_URL değerlerini alır. DATABASE_URL değerini POSTGRES_USER, POSTGRES_PASSWORD ve POSTGRES_DB değerlerinden oluşturur.

Uygulama

Uygulama kapsayıcısı, ghcr.io/lowcarbcheck/openplate. Hiçbir şey ayarlanmadan başlar. configuration.md kapsamlı özelliklerini ayrıntılı olarak açıklar.

Sunucu ve adresler

Dil ve içerik

Eşitleme ve örnek türü

Örnek tarafından sağlanan yapay zeka

Gıda veri tabanı

Analitik, bülten ve güncellemeler

Günlük kaydı

Bir örneği kapatma

Çekirdek sunucu (openplate-core)

Çekirdek sunucu konteyneri, ghcr.io/lowcarbcheck/openplate-core. İki değere ihtiyacı vardır: compose dosyalarının senin için doldurduğu DATABASE_URL ve SERVER_SECRET. Diğer her şey isteğe bağlıdır ve sen ayarlayana kadar kapalıdır. openplate-core'un README dosyası özellikleri açıklar.

Sunucu ve adresler

Veritabanı

Gizli anahtarlar

Hesaplar ve kayıt

Davetler ve denemeler

E-posta

Yapay zeka vekili ve sınırları

Onay

Anlık bildirim

Planlar

Geri bildirim, paylaşım ve araştırma

Günlük kaydı ve diğerleri

Çıkarım servisi (openplate-inference)

Çıkarım konteyneri, ghcr.io/lowcarbcheck/openplate-inference. Model çalışma zamanını ve servisi tek bir konteynerde çalıştırır. openplate-inference yapılandırma kılavuzu seçenekleri ayrıntılı olarak açıklar.

Servis ve erişim

Model ve ağırlıklar

Sınırlar

Yemek verileri

Başlatmayı durduran ayarlar

Başlamayan bir konteyneri fark etmek kolaydır ve maliyeti tek bir yeniden başlatmadır. Sessizce yok sayılan bir ayar ise bir şeyin çalışmadığı halde çalıştığını sanmana yol açar. Bu yüzden aşağıdaki her kural önyüklemeyi durdurur ve günlükte değişkenin adı belirtilir.

Reddedilen adlar

Bu adlar bir zamanlar ayardı. Artık servis bunlardan biri ayarlıyken başlamayı reddeder ve yerine ne kullanılacağını söyler. Çekirdek sunucu boş bir değerle bile bunları reddeder, bu nedenle satırı sil. Uygulama GATEWAY_URL değişkenini yalnızca bir değere sahip olduğunda reddeder.

Değişkenler arası kurallar

Uygulama.

• MATOMO_URL ve MATOMO_SITE_ID: ikisini de ayarla ya da hiçbirini ayarlama. MATOMO_EVENT_LEVEL için ikisi de gerekir.
• NEWSLETTER_SUBSCRIBE_URL ve NEWSLETTER_TURNSTILE_SITE_KEY: ikisini de ayarla ya da hiçbirini ayarlama.
• INSTANCE_MODE=managed için CORE_URL gerekir.
• CORE_URL ve desteği sonlandırılan SYNC_SERVER_URL: birini ayarla. İkisi de farklı adreslere ayarlanmışsa, bu sürüm için SYNC_SERVER_URL geçerli olur ve önyükleme tek bir uyarı günlüğe kaydeder.
• NODE_ENV=production durumunda APP_URL zorunludur.
• MOVED_TO_URL, kullanıcı adı veya parola içermeyen, APP_URL dışındaki bir ana bilgisayarda bulunan bir https:// adresi olmalıdır.
• Listesinin dışındaki bir değer önyüklemeyi durdurur: DEFAULT_UI_LANGUAGE, NUTRIENT_REFERENCE_BASIS, INSTANCE_MODE, MATOMO_EVENT_LEVEL ve FOOD_DB_BACKFILL. Pozitif bir tam sayı olmayan FOOD_DB_DAILY_CALL_LIMIT de önyüklemeyi durdurur. CORE_URL, DEFAULT_INFERENCE_BASE_URL, MATOMO_URL veya NEWSLETTER_SUBSCRIBE_URL içindeki hatalı biçimlendirilmiş adresler de önyüklemeyi durdurur. MATOMO_SITE_ID pozitif bir tam sayı değilse veya CONTENT_DIR bir dizin değilse önyükleme yine durur.

Çekirdek sunucu.

• DATABASE_URL ve SERVER_SECRET zorunludur.
• Asgari uzunluklar: SERVER_SECRET ve TRIAL_ADDRESS_PEPPER için 32 karakter, ADMIN_TOKEN ve BILLING_TOKEN için 24 karakter.
• E-posta tek bir aktarım yöntemi kullanır. HTTP e-posta API'si dördüne birden ihtiyaç duyar: MAIL_API_URL, MAIL_API_KEY, MAIL_API_FROM ve MAIL_OPERATOR_EMAIL. SMTP için SMTP_HOST, SMTP_FROM ve MAIL_OPERATOR_EMAIL gerekir, SMTP_USER ve SMTP_PASSWORD ise birlikte kullanılır. İki aktarım yönteminin değişkenlerinin aynı anda bulunması açılışı durdurur, hiçbir aktarım yöntemi olmadan MAIL_OPERATOR_EMAIL kullanılması da aynı şekilde durdurur.
• E-posta için SERVER_PUBLIC_URL ve CLIENT_BASE_URL gerekir. NODE_ENV=production etkinken her ikisi de localhost değil, başka bir sunucudaki https:// adresleri olmalıdır.
• İkisini de ayarla ya da hiçbirini ayarlama: UPSTREAM_BASE_URL ve UPSTREAM_API_KEY; PLANS_UPSTREAM_URL ve PLANS_UPSTREAM_SECRET; TURNSTILE_SECRET_KEY ve TURNSTILE_SITE_KEY; MEMBER_INVITE_DAILY_AI_LIMIT ve MEMBER_INVITE_ALLOWANCE_DAYS; TRIAL_SCANS ve TRIAL_DAILY_AI_LIMIT.
• Üçünü de ayarla ya da hiçbirini ayarlama: VAPID_PUBLIC_KEY, VAPID_PRIVATE_KEY ve VAPID_SUBJECT.
• X, Y'yi gerektirir: OPEN_SIGNUP=true e-posta gerektirir. Turnstile ikilisi OPEN_SIGNUP=true gerektirir. MEMBER_INVITE_LIFETIME_CAP, üye davet ikilisini veya MEMBER_INVITE_TRIAL=true gerektirir. MEMBER_INVITE_TRIAL=true, deneme ikilisini gerektirir ve üye davet ikilisini reddeder. Deneme ikilisi TRIAL_ADDRESS_PEPPER gerektirir. TRIAL_DAYS ve AI_TRIAL_INSTANCE_DAILY_LIMIT deneme ikilisini gerektirir. AI_TRIAL_NETWORK_DAILY_LIMIT, AI_TRIAL_INSTANCE_DAILY_LIMIT gerektirir. TRIAL_TIME_ZONE, TRIAL_DAYS gerektirir. SYNC_NOTICE_URL, SYNC_NOTICE gerektirir.
• "Kapalı" gibi okunup tam tersi anlama geleceği yerlerde sıfır kabul edilmez: AI_INSTANCE_DAILY_LIMIT, AI_TRIAL_INSTANCE_DAILY_LIMIT, AI_TRIAL_NETWORK_DAILY_LIMIT, TRIAL_SCANS, TRIAL_DAILY_AI_LIMIT, TRIAL_DAYS, MEMBER_INVITE_DAILY_AI_LIMIT ve MEMBER_INVITE_ALLOWANCE_DAYS. 0 kabul eden iki tanesi hariç, diğer tüm sayılar da pozitif olmalıdır: TRUST_PROXY ve 0 değerinin üyelere gönderecek hiçbir şey bırakmadığı MEMBER_INVITE_LIFETIME_CAP.
• Üst sınırlar: TRIAL_SCANS 100, TRIAL_DAYS 90, TRIAL_DAILY_AI_LIMIT ve MEMBER_INVITE_DAILY_AI_LIMIT 10000, SYNC_NOTICE 280 karakter, INSTANCE_NAME 64 karakter.
• SYNC_SHARING, SYNC_RESEARCH, SYNC_FEEDBACK, DATABASE_SSL ve MEMBER_INVITE_TRIAL değişkenleri true, false, 1 veya 0 kabul eder. OPEN_SIGNUP yalnızca true kabul eder.
• Listesinin dışındaki bir değer açılışı durdurur: INSTANCE_LANGUAGE, NUTRIENT_REFERENCE_BASIS, LOG_LEVEL, TRIAL_TIME_ZONE ve HEALTH_CONSENT_VERSION. mailto: veya https: olmayan bir VAPID_SUBJECT açılışı durdurur. Şema, bağlantı noktası veya yol içeren bir SMTP_HOST de açılışı durdurur. SERVER_PUBLIC_URL, CLIENT_BASE_URL, UPSTREAM_BASE_URL, PLANS_UPSTREAM_URL veya SYNC_NOTICE_URL içindeki hatalı biçimlendirilmiş adresler de açılışı durdurur.

Çıkarım servisi.

• MODEL_PROFILE=external için MODEL_RUNTIME_URL gerekir. Diğer tüm profillerde, paketle gelen adres dışındaki bir MODEL_RUNTIME_URL konteyneri durdurur.
• Listesinin dışındaki bir MODEL_PROFILE, FOOD_SOURCE, PROFILE veya LOG_LEVEL açılışı durdurur. http:// veya https:// adresi olmayan bir MODEL_RUNTIME_URL ya da EMBEDDING_RUNTIME_URL de açılışı durdurur.
• Sayılar ve boyutlar pozitif tam sayı olmalıdır. LATENCY_CEILING_MS ve RUNTIME_COMPLETION_TIMEOUT_MS değişkenleri 0 değerini de kabul eder. IMAGE_MAX_LONG_EDGE en az 112, PORT en fazla 65535 olmalıdır.

Turnstile ile kayıt olma

Varsayılan olarak bir hesap yalnızca bir davetten gelir. Çekirdek sunucuda OPEN_SIGNUP=true ayarla, böylece herkes kendi adresiyle bir hesap talep edebilir. Servis daha sonra bu adrese bir davet postalar ve mektup adresin çalıştığını kanıtlar. Bu yüzden açık kayıt için e-posta gerekir ve servis bu olmadan başlamaz. Uygulama, kayıt formunu yalnızca çekirdek sunucu kapısının açık olduğunu söylediğinde gösterir.

Captcha, betiklerin servisi istek yağmuruna tutmasını engeller. İki anahtarı yapılandırdığında çekirdek sunucu bir Cloudflare Turnstile captcha'sını kontrol eder:

1. 01
   Cloudflare kontrol panelinde oturum aç, Turnstile sayfasını aç ve Add widget seçeneğini seç. Ücretsiz bir hesap yeterlidir. Alan adının Cloudflare kullanması gerekmez.
2. 02
   Gerece bir ad ver, uygulamanın openplate.example.com gibi ana bilgisayar adını ekle ve modu Yönetilen olarak bırak. Oluştur seçeneğini seç.
3. 03
   Site anahtarını TURNSTILE_SITE_KEY içine, gizli anahtarı ise çekirdek sunucudaki TURNSTILE_SECRET_KEY içine ayarla. Ya iki anahtarı da ayarla ya da hiçbirini ayarlama.
4. 04
   Çekirdek sunucuyu örneğin docker compose -f <your file> up -d ile yeniden oluştur.

/health ardından site anahtarını yayınlar. Uygulamanın kayıt sayfası captcha'yı gösterir. Gönder düğmesi, kullanıcı bunu çözene kadar etkinleşmez. Gizli anahtar çekirdek sunucuyu asla terk etmez. Servis, ziyaretçinin adresini değil, captcha yanıtını ve gizli anahtarı Cloudflare'e gönderir.

Servis yalnızca kayıt isteğini, yani POST /v1/auth/signup-request isteğini denetler. Giriş yapma, davet açma ve diğer tüm rotalarda doğrulama yoktur. Servis Cloudflare tarafına erişemediğinde 503 döner ve kişi daha sonra tekrar deneyebilir. Denetim başarısızlık durumunda geçit vermez, bu yüzden yanıtsız kalan bir istek asla onaylanmaz.

Uygulamanın Content-Security-Policy ayarı, Cloudflare doğrulamasını yalnızca yönetilen bir kurulumda (INSTANCE_MODE=managed) veya bülten formu açıkken onaylar. Diğer kurulumlarda tarayıcı doğrulamayı engeller ve kimse formu gönderemez. Doğrulamayı açmadan önce uygulamayı yönetilen olarak ayarla.

İki anahtar olmadan da açık kayıt çalışmaya devam eder. Diğer sınırları yine geçerlidir. Servis tek bir adresten saatte beş isteğe ve tek bir posta kutusu için günde bir e-postaya izin verir. Bilinen tek kullanımlık e-posta servislerinden gelen adresleri engeller. Servis başlangıçta bir uyarı günlüğü düşer.

NEWSLETTER_TURNSTILE_SITE_KEY ayrı bir ayardır. Uygulamaya aittir ve açılış sayfasındaki bülten formunu korur. Gizli anahtarı openplate tarafında değil, o formu alan serviste durur. Bülten kaydı bunu açıklar.

İmajı kendin derlemek

Dockerfile dosyaları birkaç derleme argümanı kabul eder. Bunlar çalışan bir konteyner için ayar değildir. OPENPLATE_BUILD_SHA, commit bilgisini uygulamanın paketine basar. Çıkarım imajı, üzerine inşa edilecek llama.cpp sunucu imajı olan BASE_IMAGE değerini alır. Ayrıca derleme için Node.js imajı olan NODE_IMAGE değerini alır. VITE_ALLOWED_HOSTS yalnızca uygulamanın geliştirme sunucusuna uygulanır ve öntanımlı sunucuları yoktur.