इस प्रोजेक्ट के बारे में

Etherpad एक रीयल-टाइम सहयोगी दस्तावेज़ संपादक है, जो उन दस्तावेज़ों के लिए डिज़ाइन किया गया है जहाँ लेखकत्व और इतिहास महत्वपूर्ण होते हैं। इसे 2009 से एक छोटी स्वयंसेवक टीम द्वारा बनाए रखा गया है और Apache License v2 के तहत जारी किया गया है। README में वर्णित मुख्य क्षमताएँ: - रीयल-टाइम सहयोगी संपादन, जिसमें हर कीस्ट्रोक उसके लेखक को सौंपा जाता है और लेखक के रंग इनलाइन दिखाए जाते हैं। - पूर्ण संशोधन इतिहास संरक्षित रहता है, जिसमें दस्तावेज़ के इतिहास को अक्षर-दर-अक्षर स्क्रब करने के लिए टाइमस्लाइडर होता है। - अंतर्निहित पूर्ण डेटा निर्यात, ताकि दस्तावेज़ इतिहास ऑपरेटर के लिए सुलभ बना रहे। - स्व-होस्टेड संचालन: परियोजना में कहा गया है कि कोई टेलीमेट्री और कोई अपसेल नहीं है, और AI कार्यक्षमता प्लगइन्स के माध्यम से ऑप्ट-इन है, जो ऑपरेटर की पसंद के मॉडल पर इंगित होती है। PRIVACY.md दस्तावेज़ Etherpad के अपने कोड द्वारा किए गए दो ऑप्ट-आउट नेटवर्क कॉलों का वर्णन करता है। - स्केलेबिलिटी दावा: परियोजना एक स्केल टेस्ट पृष्ठ से लिंक करती है जो प्रति पैड हजारों समकालिक संपादकों के समर्थन का संकेत देती है। - अंतर्राष्ट्रीयकरण: मुख्य रूप से TranslateWiki के माध्यम से 105 भाषाओं में अनुवादित। - विस्तार क्षमता: एक प्लगइन फ्रेमवर्क जिसमें प्लगइन साइट के माध्यम से सैकड़ों प्लगइन्स उपलब्ध हैं, जिन्हें व्यवस्थापक वेब इंटरफ़ेस या कमांड लाइन से स्थापित किया जा सकता है। - एम्बेड करने की क्षमता: पैड, उपयोगकर्ताओं और समूहों के प्रबंधन के लिए एक HTTP API, जिसमें /api/openapi.json पर OpenAPI परिभाषाएँ उपलब्ध हैं, साथ ही वेबसाइटों में पैड एम्बेड करने के लिए एक jQuery प्लगइन भी है। README में शामिल स्थापना विकल्प: - macOS/Linux/WSL (शेल) और Windows (PowerShell) के लिए वन-लाइन इंस्टालर, जो रिपॉजिटरी को क्लोन करते हैं, निर्भरताएँ स्थापित करते हैं और फ्रंटएंड का निर्माण करते हैं। Node.js >= 24 और git आवश्यक हैं। एक पर्यावरण चर सेट करके एक ही चरण में स्थापित और प्रारंभ किया जा सकता है। - Docker Hub और GitHub Container Registry पर प्रकाशित आधिकारिक छवि का उपयोग करने वाला Docker Compose उदाहरण, जिसमें PostgreSQL सेवा, प्लगइन्स और var डेटा के लिए स्थायी वॉल्यूम, और व्यवस्थापक पासवर्ड, डेटाबेस कनेक्शन और अन्य सेटिंग्स के लिए पर्यावरण चर शामिल हैं। - मैन्युअल चरण: pnpm स्थापित करें, रिपॉजिटरी क्लोन करें, pnpm i चलाएँ, pnpm run build:etherpad चलाएँ, फिर pnpm run prod चलाएँ, और localhost:9001 पर जाएँ। कॉन्फ़िगरेशन और प्रशासन: - सेटिंग्स settings.json में रहती हैं, जिसमें वैकल्पिक सेटिंग्स फ़ाइलें, क्रेडेंशियल ओवरराइड, API कुंजी और सत्र कुंजी फ़ाइलें, और ${ENV_VAR} या ${ENV_VAR:default_value} सिंटैक्स का उपयोग करके पर्यावरण-चर प्रतिस्थापन का समर्थन है। - सेटिंग्स को /admin वेब इंटरफ़ेस के माध्यम से भी बदला जा सकता है। - README उत्पादन में MySQL या PostgreSQL जैसे समर्पित डेटाबेस का उपयोग करने की सलाह देता है, और नोट करता है कि dirtyDB ड्राइवर केवल परीक्षण या विकास के लिए है। - प्रमाणीकरण के लिए, यह सादे-पाठ पासवर्ड के बजाय हैश संग्रहीत करने की सलाह देता है, और ep_hash_auth प्लगइन की ओर इशारा करता है। - OpenID Connect प्रमाणीकरण के लिए सुझाए गए प्लगइन्स में ep_openid_connect, ep_guest, ep_user_displayname और ep_stable_authorid शामिल हैं। - समृद्ध संपादन सुविधाओं के लिए सुझाए गए प्लगइन सेट में ep_align, ep_comments_page, ep_embedded_hyperlinks2, ep_font_color, ep_headings2, ep_markdown और ep_webrtc शामिल हैं। - त्वचा (स्किन) वेरिएंट को skinvariantsbuilder URL के माध्यम से देखा जा सकता है। विकास और परियोजना स्थिति: - bin/debugRun.sh के माध्यम से डिबगिंग और एक तेज़ स्टार्ट स्क्रिप्ट bin/fastRun.sh जो निर्भरता अपडेट छोड़ देती है। - रीयल-टाइम व्यवहार को रेखांकित करने वाली Easysync लाइब्रेरी रिपॉजिटरी में एक PDF में प्रलेखित है। - योगदानकर्ता दिशानिर्देश CONTRIBUTING.md में दिए गए हैं। - README में कहा गया है कि परियोजना Node.js, रीयल-टाइम सिस्टम या संस्थागत सहयोग टूलिंग में अनुभव वाले अनुरक्षकों की तलाश कर रही है। - CI बैज कोड गुणवत्ता (CodeQL), बैकएंड परीक्षण, अनुकरणित लोड, दर सीमा, Docker, और फ्रंटएंड/व्यवस्थापक परीक्षण को कवर करते हैं। बताए गए उपयोगकर्ताओं में विकिमीडिया फाउंडेशन, यूरोपीय संघ में सार्वजनिक क्षेत्र के संस्थान, विश्वविद्यालय और स्कूल, सिविक-टेक और विचार-विमर्शात्मक लोकतंत्र परियोजनाएँ, समाचार कक्ष, और कई स्व-होस्टेड इंस्टेंस शामिल हैं। सॉफ़्टवेयर आज़माने के लिए एक सार्वजनिक इंस्टेंस उपलब्ध है। सहायता चैनल GitHub Issues, एक Discord सर्वर, और जिम्मेदार भेद्यता प्रकटीकरण के लिए ईमेल संपर्क हैं।