Yapılandırma Alanı Referansı
Her alan için tam referans config.json. Bu dosya, çalışma zamanı ürün davranışını (plan sınırları, faturalandırma, web kancaları ve özellik işaretleri) kontrol eder. O ayrı .envsırları ve altyapı kablolarını barındıran.
Başlangıç Örneği
Bu, faturalandırmanın yapılandırılmadığı, şirket içinde barındırılan bir dağıtım için önerilen başlangıç noktasıdır. Tüm limitler ayarlandı null (sınırsız) ve faturalandırma özellikleri devre dışı bırakılır. Yer değiştirmek [email protected] kendi adresinizle.
yöneticiler#
Site yöneticisi erişimine izin verilen bir dizi e-posta adresi. Yöneticiler, toplu işlem planlayıcısı ve sistem çapında kullanım kontrol panelleri gibi ayrıcalıklı sayfalara erişebilir.
| Alan | Tip | Gerekli | Tanım |
|---|---|---|---|
| admins | string[] | Gerekli | Yönetici erişimine sahip e-posta adreslerinin listesi. Kullanıcının Katip hesabıyla ilişkili e-posta adresiyle eşleşmelidir. |
özellikler#
Ürün kullanıcı arayüzünün hangi bölümlerinin etkin olduğunu kontrol eden özellik bayrakları. Basit, şirket içinde barındırılan dağıtımlar için, tüm faturalandırma özelliklerini devre dışı bırakabilir ve gerekirse yalnızca zamanlayıcı işaretini bırakabilirsiniz.
| Alan | Tip | Gerekli | Tanım |
|---|---|---|---|
| subscriptionEnforcementEnabled | boolean | Gerekli | Doğru olduğunda kullanıcılar ücretli planları görüntüleyebilir ve bu planlara yükseltme yapabilir. Yanlış olduğunda, yükseltme kullanıcı arayüzü bunun yerine yakında faturalandırılacak yer tutucusunu gösterir. |
| workspaceBillingEnabled | boolean | Gerekli | Doğru olduğunda fatura katmanları ve plan bilgileri kenar çubuğunda ve çalışma alanı ayarlarında görünür. Tüm faturalandırma kullanıcı arayüzünü tamamen gizlemek için false olarak ayarlayın. |
| batchSchedulerEnabled | boolean | Gerekli | Doğru olduğunda, toplu işlem zamanlayıcısı etkindir ve yönetici tarafından erişilebilirdir. Redis ve BullMQ'nun çalışmasını gerektirir. |
| customMCPServerTokens | boolean | Gerekli | Yanlış olduğunda, MCP sunucusu standart OAuth/Clerk jetonunu kullanarak kimlik doğrulaması yapar. Doğru olduğunda, bunun yerine kendi kendini yöneten API belirteçleri kullanılır; Clerk MCP desteği olmayan ortamlar için kullanışlıdır. |
sınırlar#
Kaynak kullanımını denetleyen bir dizi sınır kümesi. Her giriş, aracılığıyla bir faturalandırma katmanına bağlanabilir. billingTier, veya olarak ayarlayın null plandan bağımsız olarak tüm kullanıcılara uygulanacak. Faturalandırma gerektirmeyen basit dağıtımlar için tek bir giriş "billingTier": null yeterlidir. null sayısal sınırlara ilişkin değerler sınırsız anlamına gelir.
| Alan | Tip | Gerekli | Tanım |
|---|---|---|---|
| id | string | Gerekli | Bu limit seti için benzersiz tanımlayıcı (ör. ücretsiz, profesyonel, varsayılan). |
| maxTrackableItems | number | Gerekli | Bir kullanıcının çalışma alanı başına oluşturabileceği maksimum izlenebilir öğe sayısı (formlar + API uç noktaları). |
| maxResponsesPerSurvey | number | null | Gerekli | Anket/form başına izin verilen maksimum yanıt sayısı. null sınırsız anlamına gelir. |
| maxWorkspaceMembers | number | null | Gerekli | Bir çalışma alanındaki maksimum üye sayısı. null sınırsız anlamına gelir. |
| maxApiLogsPerMinute | number | Gerekli | İzlenebilir öğe başına dakika başına alınabilecek maksimum günlük olayı sayısı. Fazla istekler oran sınırlıdır. |
| maxApiPayloadBytes | number | Gerekli | Tek bir günlük yükünün bayt cinsinden maksimum boyutu. Bundan daha büyük talepler reddedilir. |
| logRetentionDays | number | Gerekli | Günlük girişlerinin temizlenmeden önce tutulduğu gün sayısı. Bu katmandaki tüm günlükler için geçerlidir. |
| maxCreatedWorkspaces | number | null | Gerekli | Tek bir kullanıcının oluşturabileceği maksimum çalışma alanı sayısı. null sınırsız anlamına gelir. |
| billingTier | string | null | Gerekli | Bu sınırın geçerli olduğu faturalandırma katmanı kimliği. billing.tiers dizisindeki bir kimlikle eşleşmelidir. Bu sınırı plandan bağımsız olarak tüm kullanıcılara uygulamak için null değerine ayarlayın. |
faturalandırma#
Lemon Squeezy entegrasyonu için isteğe bağlı faturalandırma yapılandırması. Ücretli plan kullanmıyorsanız, lemonSqueezyStoreId Ve manageUrl ile null ve ayrıl tiers boş bir dizi olarak. Katman kimliği değerlerine limitler[].billingTier tarafından başvurulur; bunların tam olarak eşleşmesi gerekir.
| Alan | Tip | Gerekli | Tanım |
|---|---|---|---|
| lemonSqueezyStoreId | string | null | İsteğe bağlı | Lemon Squeezy mağaza kimliğiniz. Ödemeleri Lemon Squeezy aracılığıyla işliyorsanız gereklidir. |
| manageUrl | string | null | İsteğe bağlı | Kullanıcılara gösterilen faturalandırma yönetimi sayfasının URL'si. Tipik olarak Lemon Squeezy müşteri portalınızın URL'si. |
billing.tiers[]
Yükseltme kullanıcı arayüzünde görüntülenen faturalandırma katmanları dizisi. Her katmanın, limitler[].billingTier'daki karşılık gelen girişle eşleşen benzersiz bir kimliğe sahip olması gerekir.
| Alan | Tip | Gerekli | Tanım |
|---|---|---|---|
| id | string | Gerekli | Benzersiz katman tanımlayıcısı. Sınırlar[].billingTier tarafından referans verilmiştir. |
| name | string | Gerekli | Kullanıcılara gösterilen görünen ad (ör. Pro, Team). |
| priceLabel | string | Gerekli | Kullanıcı arayüzünde gösterilen fiyat dizesi (ör. 25 ABD doları). |
| priceInterval | string | Gerekli | Fiyatın altında gösterilen faturalandırma aralığı (ör. aylık). |
| description | string | Gerekli | Bu katmanın neler içerdiğine ilişkin kısa açıklama. |
| tone | "neutral" | "accent" | "strong" | Gerekli | Seviye kartının görsel teması. vurgulu ve güçlü vurgulanan stillerdir; nötr varsayılandır. |
| mostPopular | boolean | Gerekli | Doğru olduğunda, bu seviye kartında En Popüler rozetini gösterir. |
| lemonSqueezyVariantId | string | null | İsteğe bağlı | Bu seviye için Lemon Squeezy ürün çeşidi kimliği. Ödeme işleminin çalışması için gereklidir. |
| enabled | boolean | Gerekli | Yanlış olduğunda bu katman, faturalandırma etkin olsa bile yükseltme kullanıcı arayüzünde gizlenir. |
kullanım#
Tüm çalışma alanları ve kullanıcılar için geçerli olan genel API kullanım denetimleri.
| Alan | Tip | Gerekli | Tanım |
|---|---|---|---|
| invalidApiKeyRateLimitPerMinute | number | Gerekli | Kaynak hız sınırlamasına tabi tutulmadan önce IP başına dakika başına izin verilen geçersiz API anahtarına sahip maksimum istek sayısı. Kimlik bilgilerinin doldurulmasını önlemeye yardımcı olur. |
| maxBodyBytes | number | Gerekli | API ağ geçidi düzeyinde bir günlük isteği gövdesi için bayt cinsinden maksimum boyut. Bunu aşan istekler hizmet katmanına ulaşmadan reddedilir. |
| pageSize | number | Gerekli | Günlük görüntüleyiciyi yüklerken sayfa başına getirilen günlük girişi sayısı. |
web kancaları#
Redis ve BullMQ tarafından desteklenen giden web kancası teslim kuyruğunu kontrol eder. Buradaki hız sınırlaması, gelen günlük alımı için değil kuyruk tüketicisi için geçerlidir.
| Alan | Tip | Gerekli | Tanım |
|---|---|---|---|
| queue.enabled | boolean | Gerekli | Doğru olduğunda, giden web kancaları Redis'te sıraya alınır ve eşzamansız olarak teslim edilir. Redis'in çalışmasını gerektirir. |
| queue.rateLimitMs | number | Gerekli | Sıradan ardışık web kancası teslimatları arasında beklenecek minimum milisaniye. |
| queue.rateLimitMax | number | Gerekli | RateLimitMs penceresi içinde gönderilebilecek maksimum webhook olayı sayısı. |
grup#
Arka plan toplu planlayıcının yapılandırması. Zamanlayıcı ayrıca şu yolla etkinleştirilmelidir: features.batchSchedulerEnabled.
| Alan | Tip | Gerekli | Tanım |
|---|---|---|---|
| schedulerTimeZone | string | Gerekli | Toplu işleri planlamak için kullanılan IANA saat dilimi dizesi (ör. UTC, Amerika/New_York). Cron tabanlı işlerin ne zaman tetiklendiğini etkiler. |