Synapse |support| |development| |documentation| |license| |pypi| |python|

Synapse अब element-hq/synapse <https://github.com/element-hq/synapse>_ पर सक्रिय रूप से बनाए रखा जाता है

Synapse एक ओपन-सोर्स Matrix <https://matrix.org/>_ होमसर्वर है जिसे 2019 से 2023 तक Matrix.org Foundation के भाग के रूप में विकसित किया गया था। Matrix.org Foundation Synapse के रखरखाव के लिए संसाधन नहीं जुटा पा रही है और इसे Element द्वारा विकसित किया जा रहा है <https://github.com/element-hq/synapse>; इसके अतिरिक्त आपके पास अन्य Matrix होमसर्वरों <https://matrix.org/ecosystem/servers/> का विकल्प भी है।

अधिक जानकारी के लिए The future of Synapse and Dendrite <https://matrix.org/blog/2023/11/06/future-of-synapse-dendrite/>_ ब्लॉग पोस्ट देखें।

संक्षेप में, Matrix इंटरनेट पर संचार के लिए एक ओपन स्टैंडर्ड है, जो फेडरेशन, एन्क्रिप्शन और VoIP का समर्थन करता है। Matrix.org के पास Matrix प्रोजेक्ट के लक्ष्यों <https://matrix.org/docs/guides/introduction>_ के बारे में और अधिक कहने के लिए है, और औपचारिक विनिर्देश <https://spec.matrix.org/>_ तकनीकी विवरणों का वर्णन करता है।

.. contents::

स्थापना और कॉन्फ़िगरेशन

Synapse दस्तावेज़ीकरण Synapse को कैसे स्थापित करें <https://matrix-org.github.io/synapse/latest/setup/installation.html>_ का वर्णन करता है। हम Docker इमेज <https://matrix-org.github.io/synapse/latest/setup/installation.html#docker-images-and-ansible-playbooks>_ या Matrix.org से Debian पैकेज <https://matrix-org.github.io/synapse/latest/setup/installation.html#matrixorg-packages>_ का उपयोग करने की सलाह देते हैं।

.. _federation:

Synapse में विभिन्न प्रकार के कॉन्फ़िग विकल्प <https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html>_ हैं जिनका उपयोग स्थापना के बाद इसके व्यवहार को अनुकूलित करने के लिए किया जा सकता है। यहाँ फेडरेशन के लिए Synapse को कॉन्फ़िगर करने <https://matrix-org.github.io/synapse/latest/federate.html>_ के बारे में अतिरिक्त विवरण हैं।

.. _reverse-proxy:

Synapse के साथ रिवर्स प्रॉक्सी का उपयोग करना

Synapse के सामने एक रिवर्स प्रॉक्सी जैसे nginx <https://nginx.org/en/docs/http/ngx_http_proxy_module.html>, Apache <https://httpd.apache.org/docs/current/mod/mod_proxy_http.html>, Caddy <https://caddyserver.com/docs/quick-starts/reverse-proxy>, HAProxy <https://www.haproxy.org/> या relayd <https://man.openbsd.org/relayd.8>_ रखने की सिफारिश की जाती है। ऐसा करने का एक लाभ यह है कि आप Matrix क्लाइंट्स को रूट विशेषाधिकारों के साथ Synapse चलाने की आवश्यकता के बिना डिफ़ॉल्ट https पोर्ट (443) को उजागर कर सकते हैं। एक को कॉन्फ़िगर करने की जानकारी के लिए, रिवर्स प्रॉक्सी दस्तावेज़ <https://matrix-org.github.io/synapse/latest/reverse_proxy.html>_ देखें।

मौजूदा Synapse को अपग्रेड करना

Synapse को अपग्रेड करने के निर्देश the upgrade notes_ में हैं। कृपया इन निर्देशों की जाँच करें क्योंकि अपग्रेड करने के लिए Synapse के कुछ संस्करणों के लिए अतिरिक्त कदमों की आवश्यकता हो सकती है।

.. _the upgrade notes: https://matrix-org.github.io/synapse/develop/upgrade.html

प्लेटफ़ॉर्म निर्भरताएँ

Synapse Python और PostgreSQL जैसी कई प्लेटफ़ॉर्म निर्भरताओं का उपयोग करता है, और समर्थित अपस्ट्रीम संस्करणों का पालन करने का लक्ष्य रखता है। अधिक जानकारी के लिए अप्रचलन नीति <https://matrix-org.github.io/synapse/latest/deprecation_policy.html>_ देखें।

सुरक्षा नोट

Matrix कुछ API में कच्चा, उपयोगकर्ता-आपूर्ति किया गया डेटा प्रस्तुत करता है -- विशेष रूप से content repository endpoints_।

.. _content repository endpoints: https://matrix.org/docs/spec/client_server/latest.html#get-matrix-media-r0-download-servername-mediaid

जबकि हम XSS हमलों को कम करने का उचित प्रयास करते हैं (उदाहरण के लिए, CSP_ का उपयोग करके), एक Matrix होमसर्वर को अन्य वेब एप्लिकेशन होस्ट करने वाले डोमेन पर होस्ट नहीं किया जाना चाहिए। यह विशेष रूप से Matrix वेब क्लाइंट और वेबमेल जैसे अन्य संवेदनशील एप्लिकेशन के साथ डोमेन साझा करने पर लागू होता है। अधिक जानकारी के लिए https://developer.github.com/changes/2014-04-25-user-content-security देखें।

.. _CSP: https://github.com/matrix-org/synapse/pull/1021

आदर्श रूप से, होमसर्वर केवल एक अलग सबडोमेन पर नहीं, बल्कि पूरी तरह से अलग registered domain_ (जिसे शीर्ष-स्तरीय साइट या eTLD+1 भी कहा जाता है) पर होना चाहिए। ऐसा इसलिए है क्योंकि some attacks_ तब भी संभव हैं जब तक दो एप्लिकेशन एक ही पंजीकृत डोमेन साझा करते हैं।

.. _registered domain: https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-2.3

.. _some attacks: https://en.wikipedia.org/wiki/Session_fixation#Attacks_using_cross-subdomain_cookie

इसे एक उदाहरण से स्पष्ट करने के लिए, यदि आपका Element Web या अन्य संवेदनशील वेब एप्लिकेशन A.example1.com पर होस्ट किया गया है, तो आपको आदर्श रूप से Synapse को example2.com पर होस्ट करना चाहिए। इसके बजाय B.example1.com पर होस्ट करने से कुछ सुरक्षा मिलती है, इसलिए यह कुछ परिदृश्यों में भी स्वीकार्य है। हालांकि, आपको नहीं करना चाहिए अपने Synapse को A.example1.com पर होस्ट करना।

ध्यान दें कि उपरोक्त सभी विशेष रूप से Synapse की public_baseurl सेटिंग में उपयोग किए गए डोमेन को संदर्भित करता है। विशेष रूप से, इसका उस डोमेन पर कोई प्रभाव नहीं पड़ता है जो उस सर्वर पर होस्ट किए गए MXIDs में उल्लिखित है।

इस सलाह का पालन करने से यह सुनिश्चित होता है कि भले ही Synapse में XSS पाया जाए, अन्य एप्लिकेशन पर प्रभाव न्यूनतम होगा।

नई स्थापना का परीक्षण

अपनी नई Synapse स्थापना को आज़माने का सबसे आसान तरीका एक वेब क्लाइंट से इससे कनेक्ट करना है।

जब तक आप अपनी स्थानीय मशीन पर Synapse का एक परीक्षण इंस्टेंस नहीं चला रहे हैं, सामान्य तौर पर, किसी क्लाइंट से सफलतापूर्वक कनेक्ट करने से पहले आपको TLS समर्थन सक्षम करने की आवश्यकता होगी: TLS प्रमाणपत्र <https://matrix-org.github.io/synapse/latest/setup/installation.html#tls-certificates>_ देखें।

शुरू करने का एक आसान तरीका है क्रमशः https://app.element.io/#/login या https://app.element.io/#/register के माध्यम से Element के माध्यम से लॉगिन या पंजीकरण करना। आपको उस सर्वर को बदलना होगा जिसमें आप matrix.org से लॉग इन कर रहे हैं और इसके बजाय https://<server_name>:8448 (या यदि आप रिवर्स प्रॉक्सी का उपयोग कर रहे हैं तो केवल https://<server_name>) का Homeserver URL निर्दिष्ट करना होगा। यदि आप कोई अन्य क्लाइंट उपयोग करना पसंद करते हैं, तो हमारे client breakdown <https://matrix.org/ecosystem/clients/>_ देखें।

यदि सब कुछ ठीक रहा तो आप कम से कम लॉग इन करने, एक कमरा बनाने और संदेश भेजना शुरू करने में सक्षम होंगे।

.. _client-user-reg:

क्लाइंट से एक नया उपयोगकर्ता पंजीकृत करना

डिफ़ॉल्ट रूप से, Matrix क्लाइंट के माध्यम से नए उपयोगकर्ताओं का पंजीकरण अक्षम है। इसे सक्षम करने के लिए:

1. registration config section <https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#registration>_ में homeserver.yaml में enable_registration: true सेट करें।
2. फिर या तो: क. CAPTCHA <https://matrix-org.github.io/synapse/latest/CAPTCHA_SETUP.html>_ सेट करें, या ख. homeserver.yaml में enable_registration_without_verification: true सेट करें।

हम दृढ़ता से CAPTCHA का उपयोग करने की सलाह देते हैं, विशेष रूप से यदि आपका होमसर्वर सार्वजनिक इंटरनेट पर उजागर है। इसके बिना, कोई भी आपके होमसर्वर पर स्वतंत्र रूप से खाते पंजीकृत कर सकता है। इसका उपयोग हमलावरों द्वारा शेष Matrix फेडरेशन को लक्षित करने वाले स्पैमबॉट बनाने के लिए किया जा सकता है।

आपका नया उपयोगकर्ता नाम आंशिक रूप से server_name से और आंशिक रूप से एक स्थानीय भाग (localpart) से बनेगा जिसे आप खाता बनाते समय निर्दिष्ट करते हैं। आपका नाम इस रूप का होगा::

@localpart:my.domain.name

("at localpart on my dot domain dot name" उच्चारित)।

लॉग इन करते समय, आपको एक "Custom server" निर्दिष्ट करना होगा। 'User name' बॉक्स में अपना इच्छित localpart निर्दिष्ट करें।

समस्या निवारण और सहायता