कॉन्फ़िग फ़ील्ड संदर्भ

प्रत्येक क्षेत्र के लिए संपूर्ण संदर्भ config.json. यह फ़ाइल रनटाइम उत्पाद व्यवहार - योजना सीमा, बिलिंग, वेबहुक और फ़ीचर फ़्लैग को नियंत्रित करती है। यह से अलग है .env, जो रहस्य और बुनियादी ढांचे की वायरिंग रखता है।

स्टार्टर उदाहरण


बिना किसी बिलिंग कॉन्फ़िगर के स्व-होस्टेड परिनियोजन के लिए यह अनुशंसित प्रारंभिक बिंदु है। सभी सीमाएँ निर्धारित हैं null (असीमित), और बिलिंग सुविधाएँ अक्षम हैं। प्रतिस्थापित करें [email protected] अपने पते के साथ.

व्यवस्थापक#


ईमेल पतों की एक श्रृंखला जिसे साइट व्यवस्थापक पहुंच प्रदान की जाती है। व्यवस्थापक बैच प्रोसेस शेड्यूलर और सिस्टम-वाइड उपयोग डैशबोर्ड जैसे विशेषाधिकार प्राप्त पृष्ठों तक पहुंच सकते हैं।

मैदानप्रकारआवश्यकविवरण
adminsstring[]आवश्यकव्यवस्थापक पहुंच वाले ईमेल पतों की सूची. उपयोगकर्ता के क्लर्क खाते से जुड़े ईमेल से मेल खाना चाहिए।

विशेषताएँ#


फ़ीचर फ़्लैग जो नियंत्रित करते हैं कि उत्पाद यूआई के कौन से हिस्से सक्रिय हैं। सरल स्व-होस्टेड परिनियोजन के लिए, आप सभी बिलिंग सुविधाओं को अक्षम कर सकते हैं और यदि आवश्यक हो तो केवल शेड्यूलर ध्वज छोड़ सकते हैं।

मैदानप्रकारआवश्यकविवरण
subscriptionEnforcementEnabledbooleanआवश्यकसत्य होने पर, उपयोगकर्ता सशुल्क योजनाओं को देख और अपग्रेड कर सकते हैं। गलत होने पर, अपग्रेड यूआई इसके बजाय जल्द ही आने वाली बिलिंग प्लेसहोल्डर दिखाता है।
workspaceBillingEnabledbooleanआवश्यकसही होने पर, बिलिंग स्तर और योजना की जानकारी साइडबार और कार्यक्षेत्र सेटिंग्स में दिखाई देती है। सभी बिलिंग यूआई को पूरी तरह से छिपाने के लिए गलत पर सेट करें।
batchSchedulerEnabledbooleanआवश्यकसत्य होने पर, बैच प्रक्रिया शेड्यूलर सक्रिय और व्यवस्थापक-सुलभ है। Redis और BullMQ को चलाने की आवश्यकता है।
customMCPServerTokensbooleanआवश्यकगलत होने पर, MCP सर्वर मानक OAuth/क्लर्क टोकन का उपयोग करके प्रमाणित करता है। सही होने पर, इसके बजाय स्व-प्रबंधित एपीआई टोकन का उपयोग किया जाता है - क्लर्क एमसीपी समर्थन के बिना वातावरण के लिए उपयोगी।

सीमा#


सीमा सेट की एक श्रृंखला जो संसाधन उपयोग को नियंत्रित करती है। प्रत्येक प्रविष्टि को बिलिंग स्तर से जोड़ा जा सकता है billingTier, या सेट करें null योजना की परवाह किए बिना सभी उपयोगकर्ताओं पर लागू करने के लिए। बिना किसी बिलिंग के सरल तैनाती के लिए, एक ही प्रविष्टि "billingTier": null पर्याप्त है. null संख्यात्मक सीमा के मानों का अर्थ असीमित है।

मैदानप्रकारआवश्यकविवरण
idstringआवश्यकइस सीमा सेट के लिए विशिष्ट पहचानकर्ता (जैसे मुफ़्त, प्रो, डिफ़ॉल्ट)।
maxTrackableItemsnumberआवश्यकएक उपयोगकर्ता प्रति कार्यस्थान पर ट्रैक करने योग्य आइटम (फ़ॉर्म + एपीआई एंडपॉइंट) की अधिकतम संख्या बना सकता है।
maxResponsesPerSurveynumber | nullआवश्यकप्रति सर्वेक्षण/प्रपत्र पर अनुमत प्रतिक्रियाओं की अधिकतम संख्या। शून्य का अर्थ है असीमित.
maxWorkspaceMembersnumber | nullआवश्यककिसी कार्यक्षेत्र में सदस्यों की अधिकतम संख्या. शून्य का अर्थ है असीमित.
maxApiLogsPerMinutenumberआवश्यकलॉग ईवेंट की अधिकतम संख्या जो प्रति ट्रैक करने योग्य आइटम प्रति मिनट अंतर्ग्रहण की जा सकती है। अतिरिक्त अनुरोध दर-सीमित हैं।
maxApiPayloadBytesnumberआवश्यकएकल लॉग पेलोड के बाइट्स में अधिकतम आकार। इससे बड़े अनुरोध अस्वीकार कर दिए जाते हैं.
logRetentionDaysnumberआवश्यकशुद्ध किए जाने से पहले लॉग प्रविष्टियों को बनाए रखने के दिनों की संख्या। इस स्तर के सभी लॉग पर लागू होता है।
maxCreatedWorkspacesnumber | nullआवश्यकएक एकल उपयोगकर्ता अधिकतम संख्या में कार्यस्थान बना सकता है। शून्य का अर्थ है असीमित.
billingTierstring | nullआवश्यकबिलिंग टियर आईडी पर यह सीमा लागू होती है। बिलिंग.टियर्स सरणी में एक आईडी से मेल खाना चाहिए। योजना की परवाह किए बिना सभी उपयोगकर्ताओं पर इस सीमा को लागू करने के लिए शून्य पर सेट करें।

बिलिंग#


लेमन स्क्वीज़ी एकीकरण के लिए वैकल्पिक बिलिंग कॉन्फ़िगरेशन। यदि आप सशुल्क योजनाओं का उपयोग नहीं कर रहे हैं, तो सेट करें lemonSqueezyStoreId और manageUrl को null और चले जाओ tiers एक खाली सरणी के रूप में. टियर आईडी मान सीमाओं[].बिलिंगटियर द्वारा संदर्भित हैं - उन्हें बिल्कुल मेल खाना चाहिए।

मैदानप्रकारआवश्यकविवरण
lemonSqueezyStoreIdstring | nullवैकल्पिकआपकी लेमन स्क्वीज़ी स्टोर आईडी। यदि आप लेमन स्क्वीज़ी के माध्यम से भुगतान संसाधित कर रहे हैं तो यह आवश्यक है।
manageUrlstring | nullवैकल्पिकउपयोगकर्ताओं को दिखाए गए बिलिंग प्रबंधन पृष्ठ का URL। आमतौर पर आपका लेमन स्क्वीज़ी ग्राहक पोर्टल यूआरएल।

billing.tiers[]

अपग्रेड यूआई में प्रदर्शित बिलिंग स्तरों की श्रृंखला। प्रत्येक स्तर में एक अद्वितीय आईडी होनी चाहिए जो सीमाओं[].बिलिंगटियर में संबंधित प्रविष्टि से मेल खाती हो।

मैदानप्रकारआवश्यकविवरण
idstringआवश्यकअद्वितीय स्तरीय पहचानकर्ता. सीमाएँ[].बिलिंगटियर द्वारा संदर्भित।
namestringआवश्यकउपयोगकर्ताओं को दिखाया गया प्रदर्शन नाम (जैसे प्रो, टीम)।
priceLabelstringआवश्यकयूआई में मूल्य स्ट्रिंग दिखाई गई है (उदाहरण के लिए $25)।
priceIntervalstringआवश्यकबिलिंग अंतराल कीमत के नीचे दिखाया गया है (जैसे प्रति माह)।
descriptionstringआवश्यकइस स्तर में क्या शामिल है इसका संक्षिप्त विवरण।
tone"neutral" | "accent" | "strong"आवश्यकटियर कार्ड का दृश्य विषय. उच्चारण और मजबूत हाइलाइट की गई शैलियाँ हैं; तटस्थ डिफ़ॉल्ट है.
mostPopularbooleanआवश्यकसत्य होने पर, इस स्तरीय कार्ड पर सर्वाधिक लोकप्रिय बैज दिखाता है।
lemonSqueezyVariantIdstring | nullवैकल्पिकइस स्तर के लिए लेमन स्क्वीज़ी उत्पाद प्रकार आईडी। काम करने के लिए चेकआउट करना आवश्यक है.
enabledbooleanआवश्यकगलत होने पर, बिलिंग सक्षम होने पर भी यह स्तर अपग्रेड यूआई से छिपा रहता है।

प्रयोग#


वैश्विक एपीआई उपयोग नियंत्रण जो सभी कार्यस्थानों और उपयोगकर्ताओं पर लागू होते हैं।

मैदानप्रकारआवश्यकविवरण
invalidApiKeyRateLimitPerMinutenumberआवश्यकस्रोत दर-सीमित होने से पहले प्रति आईपी प्रति मिनट अमान्य एपीआई कुंजी के साथ अनुरोधों की अधिकतम संख्या की अनुमति है। क्रेडेंशियल स्टफिंग को रोकने में मदद करता है।
maxBodyBytesnumberआवश्यकएपीआई गेटवे स्तर पर लॉग अनुरोध निकाय के लिए बाइट्स में अधिकतम आकार। इससे अधिक के अनुरोध सेवा स्तर तक पहुंचने से पहले ही अस्वीकार कर दिए जाते हैं।
pageSizenumberआवश्यकलॉग व्यूअर लोड करते समय प्रति पृष्ठ प्राप्त लॉग प्रविष्टियों की संख्या।

वेबहुक#


रेडिस और बुलएमक्यू द्वारा समर्थित आउटबाउंड वेबहुक डिलीवरी कतार को नियंत्रित करता है। यहां दर सीमित करना कतार उपभोक्ता पर लागू होता है, इनबाउंड लॉग अंतर्ग्रहण पर नहीं।

मैदानप्रकारआवश्यकविवरण
queue.enabledbooleanआवश्यकसही होने पर, आउटबाउंड वेबहुक को रेडिस में कतारबद्ध किया जाता है और अतुल्यकालिक रूप से वितरित किया जाता है। Redis को चलाने की आवश्यकता है।
queue.rateLimitMsnumberआवश्यककतार से लगातार वेबहुक डिलीवरी के बीच प्रतीक्षा करने के लिए न्यूनतम मिलीसेकंड।
queue.rateLimitMaxnumberआवश्यकरेटलिमिटएम विंडो के भीतर भेजे जा सकने वाले वेबहुक इवेंट की अधिकतम संख्या।

बैच#


पृष्ठभूमि बैच शेड्यूलर के लिए कॉन्फ़िगरेशन। शेड्यूलर को भी इसके माध्यम से सक्षम किया जाना चाहिए features.batchSchedulerEnabled.

मैदानप्रकारआवश्यकविवरण
schedulerTimeZonestringआवश्यकIANA टाइमज़ोन स्ट्रिंग का उपयोग बैच नौकरियों को शेड्यूल करने के लिए किया जाता है (उदाहरण के लिए UTC, अमेरिका/न्यू_यॉर्क)। क्रॉन-आधारित नौकरियां ट्रिगर होने पर प्रभावित होता है।