कॉन्फ़िग फ़ील्ड संदर्भ
प्रत्येक क्षेत्र के लिए संपूर्ण संदर्भ config.json. यह फ़ाइल रनटाइम उत्पाद व्यवहार - योजना सीमा, बिलिंग, वेबहुक और फ़ीचर फ़्लैग को नियंत्रित करती है। यह से अलग है .env, जो रहस्य और बुनियादी ढांचे की वायरिंग रखता है।
स्टार्टर उदाहरण
बिना किसी बिलिंग कॉन्फ़िगर के स्व-होस्टेड परिनियोजन के लिए यह अनुशंसित प्रारंभिक बिंदु है। सभी सीमाएँ निर्धारित हैं null (असीमित), और बिलिंग सुविधाएँ अक्षम हैं। प्रतिस्थापित करें [email protected] अपने पते के साथ.
व्यवस्थापक#
ईमेल पतों की एक श्रृंखला जिसे साइट व्यवस्थापक पहुंच प्रदान की जाती है। व्यवस्थापक बैच प्रोसेस शेड्यूलर और सिस्टम-वाइड उपयोग डैशबोर्ड जैसे विशेषाधिकार प्राप्त पृष्ठों तक पहुंच सकते हैं।
| मैदान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| admins | string[] | आवश्यक | व्यवस्थापक पहुंच वाले ईमेल पतों की सूची. उपयोगकर्ता के क्लर्क खाते से जुड़े ईमेल से मेल खाना चाहिए। |
विशेषताएँ#
फ़ीचर फ़्लैग जो नियंत्रित करते हैं कि उत्पाद यूआई के कौन से हिस्से सक्रिय हैं। सरल स्व-होस्टेड परिनियोजन के लिए, आप सभी बिलिंग सुविधाओं को अक्षम कर सकते हैं और यदि आवश्यक हो तो केवल शेड्यूलर ध्वज छोड़ सकते हैं।
| मैदान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| subscriptionEnforcementEnabled | boolean | आवश्यक | सत्य होने पर, उपयोगकर्ता सशुल्क योजनाओं को देख और अपग्रेड कर सकते हैं। गलत होने पर, अपग्रेड यूआई इसके बजाय जल्द ही आने वाली बिलिंग प्लेसहोल्डर दिखाता है। |
| workspaceBillingEnabled | boolean | आवश्यक | सही होने पर, बिलिंग स्तर और योजना की जानकारी साइडबार और कार्यक्षेत्र सेटिंग्स में दिखाई देती है। सभी बिलिंग यूआई को पूरी तरह से छिपाने के लिए गलत पर सेट करें। |
| batchSchedulerEnabled | boolean | आवश्यक | सत्य होने पर, बैच प्रक्रिया शेड्यूलर सक्रिय और व्यवस्थापक-सुलभ है। Redis और BullMQ को चलाने की आवश्यकता है। |
| customMCPServerTokens | boolean | आवश्यक | गलत होने पर, MCP सर्वर मानक OAuth/क्लर्क टोकन का उपयोग करके प्रमाणित करता है। सही होने पर, इसके बजाय स्व-प्रबंधित एपीआई टोकन का उपयोग किया जाता है - क्लर्क एमसीपी समर्थन के बिना वातावरण के लिए उपयोगी। |
सीमा#
सीमा सेट की एक श्रृंखला जो संसाधन उपयोग को नियंत्रित करती है। प्रत्येक प्रविष्टि को बिलिंग स्तर से जोड़ा जा सकता है billingTier, या सेट करें null योजना की परवाह किए बिना सभी उपयोगकर्ताओं पर लागू करने के लिए। बिना किसी बिलिंग के सरल तैनाती के लिए, एक ही प्रविष्टि "billingTier": null पर्याप्त है. null संख्यात्मक सीमा के मानों का अर्थ असीमित है।
| मैदान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| id | string | आवश्यक | इस सीमा सेट के लिए विशिष्ट पहचानकर्ता (जैसे मुफ़्त, प्रो, डिफ़ॉल्ट)। |
| maxTrackableItems | number | आवश्यक | एक उपयोगकर्ता प्रति कार्यस्थान पर ट्रैक करने योग्य आइटम (फ़ॉर्म + एपीआई एंडपॉइंट) की अधिकतम संख्या बना सकता है। |
| maxResponsesPerSurvey | number | null | आवश्यक | प्रति सर्वेक्षण/प्रपत्र पर अनुमत प्रतिक्रियाओं की अधिकतम संख्या। शून्य का अर्थ है असीमित. |
| maxWorkspaceMembers | number | null | आवश्यक | किसी कार्यक्षेत्र में सदस्यों की अधिकतम संख्या. शून्य का अर्थ है असीमित. |
| maxApiLogsPerMinute | number | आवश्यक | लॉग ईवेंट की अधिकतम संख्या जो प्रति ट्रैक करने योग्य आइटम प्रति मिनट अंतर्ग्रहण की जा सकती है। अतिरिक्त अनुरोध दर-सीमित हैं। |
| maxApiPayloadBytes | number | आवश्यक | एकल लॉग पेलोड के बाइट्स में अधिकतम आकार। इससे बड़े अनुरोध अस्वीकार कर दिए जाते हैं. |
| logRetentionDays | number | आवश्यक | शुद्ध किए जाने से पहले लॉग प्रविष्टियों को बनाए रखने के दिनों की संख्या। इस स्तर के सभी लॉग पर लागू होता है। |
| maxCreatedWorkspaces | number | null | आवश्यक | एक एकल उपयोगकर्ता अधिकतम संख्या में कार्यस्थान बना सकता है। शून्य का अर्थ है असीमित. |
| billingTier | string | null | आवश्यक | बिलिंग टियर आईडी पर यह सीमा लागू होती है। बिलिंग.टियर्स सरणी में एक आईडी से मेल खाना चाहिए। योजना की परवाह किए बिना सभी उपयोगकर्ताओं पर इस सीमा को लागू करने के लिए शून्य पर सेट करें। |
बिलिंग#
लेमन स्क्वीज़ी एकीकरण के लिए वैकल्पिक बिलिंग कॉन्फ़िगरेशन। यदि आप सशुल्क योजनाओं का उपयोग नहीं कर रहे हैं, तो सेट करें lemonSqueezyStoreId और manageUrl को null और चले जाओ tiers एक खाली सरणी के रूप में. टियर आईडी मान सीमाओं[].बिलिंगटियर द्वारा संदर्भित हैं - उन्हें बिल्कुल मेल खाना चाहिए।
| मैदान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| lemonSqueezyStoreId | string | null | वैकल्पिक | आपकी लेमन स्क्वीज़ी स्टोर आईडी। यदि आप लेमन स्क्वीज़ी के माध्यम से भुगतान संसाधित कर रहे हैं तो यह आवश्यक है। |
| manageUrl | string | null | वैकल्पिक | उपयोगकर्ताओं को दिखाए गए बिलिंग प्रबंधन पृष्ठ का URL। आमतौर पर आपका लेमन स्क्वीज़ी ग्राहक पोर्टल यूआरएल। |
billing.tiers[]
अपग्रेड यूआई में प्रदर्शित बिलिंग स्तरों की श्रृंखला। प्रत्येक स्तर में एक अद्वितीय आईडी होनी चाहिए जो सीमाओं[].बिलिंगटियर में संबंधित प्रविष्टि से मेल खाती हो।
| मैदान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| id | string | आवश्यक | अद्वितीय स्तरीय पहचानकर्ता. सीमाएँ[].बिलिंगटियर द्वारा संदर्भित। |
| name | string | आवश्यक | उपयोगकर्ताओं को दिखाया गया प्रदर्शन नाम (जैसे प्रो, टीम)। |
| priceLabel | string | आवश्यक | यूआई में मूल्य स्ट्रिंग दिखाई गई है (उदाहरण के लिए $25)। |
| priceInterval | string | आवश्यक | बिलिंग अंतराल कीमत के नीचे दिखाया गया है (जैसे प्रति माह)। |
| description | string | आवश्यक | इस स्तर में क्या शामिल है इसका संक्षिप्त विवरण। |
| tone | "neutral" | "accent" | "strong" | आवश्यक | टियर कार्ड का दृश्य विषय. उच्चारण और मजबूत हाइलाइट की गई शैलियाँ हैं; तटस्थ डिफ़ॉल्ट है. |
| mostPopular | boolean | आवश्यक | सत्य होने पर, इस स्तरीय कार्ड पर सर्वाधिक लोकप्रिय बैज दिखाता है। |
| lemonSqueezyVariantId | string | null | वैकल्पिक | इस स्तर के लिए लेमन स्क्वीज़ी उत्पाद प्रकार आईडी। काम करने के लिए चेकआउट करना आवश्यक है. |
| enabled | boolean | आवश्यक | गलत होने पर, बिलिंग सक्षम होने पर भी यह स्तर अपग्रेड यूआई से छिपा रहता है। |
प्रयोग#
वैश्विक एपीआई उपयोग नियंत्रण जो सभी कार्यस्थानों और उपयोगकर्ताओं पर लागू होते हैं।
| मैदान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| invalidApiKeyRateLimitPerMinute | number | आवश्यक | स्रोत दर-सीमित होने से पहले प्रति आईपी प्रति मिनट अमान्य एपीआई कुंजी के साथ अनुरोधों की अधिकतम संख्या की अनुमति है। क्रेडेंशियल स्टफिंग को रोकने में मदद करता है। |
| maxBodyBytes | number | आवश्यक | एपीआई गेटवे स्तर पर लॉग अनुरोध निकाय के लिए बाइट्स में अधिकतम आकार। इससे अधिक के अनुरोध सेवा स्तर तक पहुंचने से पहले ही अस्वीकार कर दिए जाते हैं। |
| pageSize | number | आवश्यक | लॉग व्यूअर लोड करते समय प्रति पृष्ठ प्राप्त लॉग प्रविष्टियों की संख्या। |
वेबहुक#
रेडिस और बुलएमक्यू द्वारा समर्थित आउटबाउंड वेबहुक डिलीवरी कतार को नियंत्रित करता है। यहां दर सीमित करना कतार उपभोक्ता पर लागू होता है, इनबाउंड लॉग अंतर्ग्रहण पर नहीं।
| मैदान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| queue.enabled | boolean | आवश्यक | सही होने पर, आउटबाउंड वेबहुक को रेडिस में कतारबद्ध किया जाता है और अतुल्यकालिक रूप से वितरित किया जाता है। Redis को चलाने की आवश्यकता है। |
| queue.rateLimitMs | number | आवश्यक | कतार से लगातार वेबहुक डिलीवरी के बीच प्रतीक्षा करने के लिए न्यूनतम मिलीसेकंड। |
| queue.rateLimitMax | number | आवश्यक | रेटलिमिटएम विंडो के भीतर भेजे जा सकने वाले वेबहुक इवेंट की अधिकतम संख्या। |
बैच#
पृष्ठभूमि बैच शेड्यूलर के लिए कॉन्फ़िगरेशन। शेड्यूलर को भी इसके माध्यम से सक्षम किया जाना चाहिए features.batchSchedulerEnabled.
| मैदान | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| schedulerTimeZone | string | आवश्यक | IANA टाइमज़ोन स्ट्रिंग का उपयोग बैच नौकरियों को शेड्यूल करने के लिए किया जाता है (उदाहरण के लिए UTC, अमेरिका/न्यू_यॉर्क)। क्रॉन-आधारित नौकरियां ट्रिगर होने पर प्रभावित होता है। |