सर्वर चलाएँ
साइन-इन और एक्सेस
Oleafly Server के लिए साइन-इन प्रोवाइडर और ईमेल सेट करें, एक्सेस नियमों, खुले साइन-अप, भूमिकाओं और अतिथियों के साथ तय करें कि कौन अंदर आए, ब्राउज़र से एक्सेस चालू करें, और Oleafly के एडमिन कंसोल से सर्वर चलाएँ।
लोग आपके द्वारा कॉन्फ़िगर किए गए प्रोवाइडरों के ज़रिए Oleafly Server पर साइन इन करते हैं, इसलिए सर्वर कभी पासवर्ड को हाथ नहीं लगाता। आप एक्सेस नियमों से तय करते हैं कि कौन अंदर आ सकता है। बाक़ी काम एडमिन Oleafly के एडमिन कंसोल से सँभालते हैं।
साइन-इन प्रोवाइडर
“साइन-इन प्रोवाइडर” शीर्षक वाला अनुभागकम से कम एक प्रोवाइडर कॉन्फ़िगर करें। बिना इसके सर्वर शुरू नहीं होता, और उसका लॉग बताता है कि कौन-सी सेटिंग जोड़नी है। पहला एडमिन इसी से साइन इन करता है, क्योंकि ईमेल लिंक से साइन-इन तब तक बंद रहता है जब तक कोई एडमिन उसे चालू न कर दे। हर प्रोवाइडर लोगों को आपके सर्वर पर एक कॉलबैक पते पर वापस भेजता है:
https://collab.example.org/auth/callback/<provider>
अगर OLEAFLY_PUBLIC_URL में कोई पाथ है, तो कॉलबैक पते में भी वह पाथ होता है, जैसे https://www.cs.example.edu/oleafly/auth/callback/github।
- GitHub पर अपनी प्रोफ़ाइल तस्वीर चुनें, फिर Settings › Developer settings › OAuth apps चुनें, और New OAuth App चुनें। किसी संगठन के मालिकाना ऐप के लिए उसके बजाय संगठन की सेटिंग में Developer settings का इस्तेमाल करें।
- Application name (जैसे
Smith Lab Oleafly), Homepage URL (https://collab.example.org) और Authorization callback URL (https://collab.example.org/auth/callback/github) भरें। Enable Device Flow बंद छोड़ दें। - Register application चुनें। Client ID कॉपी करें, फिर Generate a new client secret चुनें और सीक्रेट कॉपी करें।
OLEAFLY_GITHUB_CLIENT_IDऔरOLEAFLY_GITHUB_CLIENT_SECRETसेट करें, और सर्वर फिर से चालू करें।
सर्वर GitHub से सिर्फ़ उस व्यक्ति की प्रोफ़ाइल और ईमेल पते माँगता है (read:user और user:email)। OLEAFLY_GITHUB_LABEL साइन-इन बटन पर लिखे टेक्स्ट को बदलता है।
GitHub Enterprise Server के लिए ऐप वहीं रजिस्टर करें और OLEAFLY_GITHUB_URL को उसके पते पर सेट करें, जैसे https://github.example.edu। OLEAFLY_GITHUB_API_URL सिर्फ़ तब सेट करें जब आपका API पता असामान्य हो।
OpenID Connect
“OpenID Connect” शीर्षक वाला अनुभागOpenID Connect में GitLab, Google, Microsoft Entra ID, Keycloak, Authentik, Okta और ज़्यादातर विश्वविद्यालयों के सिंगल साइन-ऑन सिस्टम आ जाते हैं। अगर आपका विश्वविद्यालय सिर्फ़ SAML देता है, तो बीच में Keycloak या Dex लगा दें।
-
अक्षरों और अंकों से बना एक छोटा नाम चुनें, जैसे
GITLAB। यह वेरिएबल नामों का हिस्सा बन जाता है, और छोटे अक्षरों में लिखा यही नाम कॉलबैक पते का हिस्सा बन जाता है। Compose की.envफ़ाइल मेंUNIVERSITYवाली लाइनों का नाम बदलें या दूसरा ब्लॉक जोड़ें। -
अपने प्रोवाइडर के पास एक ऐप्लिकेशन रजिस्टर करें। कॉन्फ़िडेंशियल या वेब ऐप्लिकेशन चुनें, redirect URI को
https://collab.example.org/auth/callback/gitlabपर सेट करें, औरopenid,emailऔरprofileस्कोप की अनुमति दें। -
प्रोवाइडर की जानकारी जोड़ें:
OLEAFLY_OIDC_GITLAB_ISSUER=https://gitlab.comOLEAFLY_OIDC_GITLAB_CLIENT_ID=example-client-idOLEAFLY_OIDC_GITLAB_CLIENT_SECRET=example-client-secretOLEAFLY_OIDC_GITLAB_LABEL=GitLab -
सर्वर फिर से चालू करें।
लेबल साइन-इन बटन पर लिखा टेक्स्ट है, जैसे University login। इश्यूअर वह पता है जिस पर प्रोवाइडर /.well-known/openid-configuration प्रकाशित करता है। कुछ आम उदाहरण:
| प्रोवाइडर | इश्यूअर |
|---|---|
| GitLab.com | https://gitlab.com |
| स्व-प्रबंधित GitLab | आपका GitLab पता, जैसे https://gitlab.example.edu |
https://accounts.google.com | |
| Microsoft Entra ID | https://login.microsoftonline.com/ के बाद आपकी tenant ID और /v2.0 |
| Keycloak | https://sso.example.edu/realms/ के बाद realm का नाम |
सत्यापित ईमेल पते
“सत्यापित ईमेल पते” शीर्षक वाला अनुभागअनुमति-सूची की प्रविष्टियाँ और डोमेन नियम सिर्फ़ सत्यापित ईमेल पतों से मेल खाते हैं। सर्वर किसी पते को तभी सत्यापित मानता है जब प्रोवाइडर ऐसा कहे: GitHub उसे सत्यापित चिह्नित करे, या OpenID Connect का क्लेम email_verified true हो।
कुछ संस्थागत प्रोवाइडर वह क्लेम नहीं भेजते। अगर आपका प्रोवाइडर ऐसा है, और वह सिर्फ़ वे पते देता है जिन पर आपका विश्वविद्यालय नियंत्रण रखता है, तो OLEAFLY_OIDC_<NAME>_TRUST_EMAIL=true सेट करें। ऐसे प्रोवाइडर के लिए इसे कभी सेट न करें जहाँ लोग अपनी मर्ज़ी का कोई भी ईमेल पता टाइप कर सकते हैं। तब कोई भी आपकी अनुमति-सूची में शामिल किसी व्यक्ति के रूप में साइन इन कर सकता था।
आपके विश्वविद्यालय द्वारा साइन किए प्रमाणपत्र
“आपके विश्वविद्यालय द्वारा साइन किए प्रमाणपत्र” शीर्षक वाला अनुभागअगर आपका विश्वविद्यालय अपने प्रॉक्सी या अपनी साइन-इन सेवा के लिए अपने प्रमाणपत्र ख़ुद साइन करता है, तो सर्वर को उस प्रमाणपत्र प्राधिकरण पर भरोसा करना होगा। हर उस कंप्यूटर को भी जो Oleafly चलाता है।
Docker के बिना, प्रमाणपत्र को ऑपरेटिंग सिस्टम में जोड़ें। Debian और Ubuntu पर इसे .crt पर समाप्त होने वाले नाम के साथ /usr/local/share/ca-certificates/ में कॉपी करें और sudo update-ca-certificates चलाएँ।
Docker इमेज में कोई पैकेज मैनेजर नहीं होता, इसलिए उसे ऐसी प्रमाणपत्र सूची दें जिसमें आपका प्रमाणपत्र शामिल हो। docker-compose.yml के बगल में, Debian या Ubuntu मशीन पर:
cat /etc/ssl/certs/ca-certificates.crt university-ca.pem > ca-bundle.pemchmod 644 ca-bundle.pemफिर उस फ़ाइल को docker-compose.override.yml में सर्वर में जोड़ें और docker compose up -d दोबारा चलाएँ:
services: oleafly-server: volumes: - ./ca-bundle.pem:/etc/ssl/certs/ca-certificates.crt:roईमेल वैकल्पिक है, और बाक़ी सब कुछ इसके बिना भी काम करता है। ईमेल के बिना आप लोगों को सर्वर का पता ख़ुद भेजते हैं, और Oleafly हर व्यक्ति के साथ साझा किए गए प्रोजेक्ट Shared with you के नीचे दिखाता है।
इसे सेट करने के लिए सर्वर को एक SMTP खाता दें:
OLEAFLY_SMTP_URL=smtps://oleafly%40example.org:example-app-password@smtp.example.org:465OLEAFLY_MAIL_FROM=Smith Lab <oleafly@example.org>दोनों लाइनें सेट करें या कोई नहीं। यूज़र नाम और पासवर्ड में आई विशेष अक्षरों को URL रूप में लिखें, जैसे @ के लिए %40।
smtps://शुरू से ही TLS इस्तेमाल करता है, पोर्ट 465 पर, जब तक आप कोई दूसरा पोर्ट न बताएँ।smtp://पोर्ट 587 इस्तेमाल करता है जब तक आप कोई दूसरा न बताएँ, फिर STARTTLS के साथ TLS पर चला जाता है। अगर मेल सर्वर STARTTLS नहीं देता, तो सर्वर भेजता नहीं।- उसी मशीन पर मेल रिले अपवाद है:
smtp://localhost,smtp://127.0.0.1औरsmtp://[::1]TLS के बिना भेजते हैं। - उसी निजी नेटवर्क पर मौजूद रिले
?tls=noneजोड़ने पर TLS छोड़ सकता है, जैसेsmtp://mailpit:1025?tls=none। तब पते में यूज़र नाम या पासवर्ड नहीं रखा जा सकता, क्योंकि वे बिना एन्क्रिप्ट हुए नेटवर्क पार करते। इसे सिर्फ़ तब इस्तेमाल करें जब उस नेटवर्क तक किसी और की पहुँच न हो।
सर्वर मेल सर्वर के प्रमाणपत्र की जाँच सिस्टम के भरोसेमंद प्रमाणपत्रों से करता है।
सर्वर क्या भेजता है
“सर्वर क्या भेजता है” शीर्षक वाला अनुभागछह तरह के ईमेल होते हैं। जिसके पास पहले से खाता है, उसे ईमेल सिर्फ़ उसके सत्यापित पतों पर जाता है, और GitHub के noreply पते हमेशा छोड़ दिए जाते हैं।
| ईमेल | कब जाता है |
|---|---|
| सर्वर पर जोड़ा गया | कोई एडमिन किसी को ईमेल पते से अनुमति-सूची में जोड़ता है। इसमें सर्वर का नाम, एक Add to Oleafly लिंक और सर्वर का पता होता है। GitHub यूज़र नाम से या डोमेन नियम से किसी को जोड़ने पर कुछ नहीं भेजा जाता, क्योंकि सर्वर के पास उनके लिए अभी कोई पता नहीं होता। |
| प्रोजेक्ट साझा किया गया | कोई प्रोजेक्ट मालिक किसी को प्रोजेक्ट में जोड़ता है। इसमें प्रोजेक्ट का शीर्षक, किसने साझा किया, उनकी भूमिका और प्रोजेक्ट खोलने वाला लिंक होता है, साथ में प्रोजेक्ट का वेब पेज, उस स्थिति के लिए जब लिंक ऐप न खोल सके। बाद में भूमिका बदलने पर कुछ नहीं भेजा जाता। हर व्यक्ति इन्हें Settings → Collaboration में सर्वर के कार्ड से बंद कर सकता है। |
| नया डिवाइस | कोई खाता किसी दूसरे डिवाइस पर साइन इन करता है। इसमें डिवाइस का नाम, उसका सिस्टम और सर्वर के समय-क्षेत्र के हिसाब से समय होता है, साथ में यह याद दिलाया जाता है कि अगर वे ख़ुद नहीं थे तो उस डिवाइस को साइन आउट कर दें। नए खाते के पहले डिवाइस पर कोई ईमेल नहीं जाता। समय-क्षेत्र चुनने के लिए TZ सेट करें, जैसे TZ=Europe/Berlin। |
| अतिथि आमंत्रण | कोई प्रोजेक्ट मालिक किसी अतिथि को आमंत्रित करता है। इसमें प्रोजेक्ट का शीर्षक, किसने आमंत्रित किया, एक Add to Oleafly लिंक और साइन इन करने का पता होता है। अनुमोदन चालू होने पर यह आमंत्रण के अनुमोदित होते ही जाता है। |
| ज़िक्र | कोई सदस्य को किसी टिप्पणी या जवाब में ज़िक्रता करता है। इसमें लिखा होता है कि किसने ज़िक्र किया, कौन-सा प्रोजेक्ट और फ़ाइल, टिप्पणी किस टेक्स्ट पर है और टिप्पणी क्या है, साथ में एक ऐसा लिंक जो टिप्पणी को Oleafly में खोलता है। यह टिप्पणी के सर्वर तक पहुँचने के क़रीब एक मिनट बाद जाता है, और उस एक मिनट में उसी व्यक्ति के ज़िक्र एक ही ईमेल में एक साथ आ जाते हैं। किसी को अपनी टिप्पणियों पर या ऐसे प्रोजेक्ट पर नहीं मिलता जिसे वे खोल नहीं सकते, और टिप्पणी संपादित करने पर एक ही ज़िक्र कभी दो बार नहीं भेजा जाता। हर व्यक्ति इन्हें Settings → Collaboration में सर्वर के कार्ड पर Email me when someone mentions me in a comment से बंद कर सकता है। |
| साइन-इन लिंक | कोई सर्वर के साइन-इन पेज पर इसका निवेदन करता है। |
एडमिन सर्वर सेटिंग में Email notifications से साइन-इन लिंक को छोड़कर हर तरह के ईमेल बंद कर सकते हैं। साइन-इन लिंक हमेशा जाते हैं, क्योंकि उनके बिना लोग साइन इन नहीं कर सकते।
इसकी जाँच करें
“इसकी जाँच करें” शीर्षक वाला अनुभागएडमिन कंसोल में Email खोलें। यह दिखाता है कि ईमेल चालू है या नहीं और From पता क्या है, पासवर्ड कभी नहीं। कोई एडमिन Send test email चुनकर अपने ही सत्यापित पते पर एक ईमेल भेज सकता है। पेज फिर बताता है कि वह भेजा गया या नहीं, या मेल सर्वर ने क्या उत्तर दिया।
जब ईमेल बंद होता है, तो पेज Add to Oleafly लिंक और सर्वर का पता दिखाता है, ताकि आप उन्हें ख़ुद भेज सकें।
जब मेल सर्वर बंद हो
“जब मेल सर्वर बंद हो” शीर्षक वाला अनुभागभेजना कभी अपने पीछे की कार्रवाई को रोककर नहीं रखता। सर्वर ईमेल को मेमोरी में एक क़तार में रखता है और 30 सेकंड, 2 मिनट, 10 मिनट, 30 मिनट और 2 घंटे बाद फिर कोशिश करता है। हर नाकाम कोशिश सर्वर लॉग में एक चेतावनी है, और Email पेज नवीनतम विफलता दिखाता है। अगर आख़िरी कोशिश भी नाकाम हो जाती है, तो सर्वर लॉग में त्रुटि दर्ज करता है और वह ईमेल छोड़ देता है। सर्वर के फिर चालू होने पर अब भी क़तार में पड़े ईमेल खो जाते हैं।
ईमेल लिंक से साइन इन करें
“ईमेल लिंक से साइन इन करें” शीर्षक वाला अनुभागलोग उस लिंक से भी साइन इन कर सकते हैं जो सर्वर उन्हें ईमेल करता है, इसलिए उन्हें GitHub या OpenID Connect खाते की ज़रूरत नहीं पड़ती। इसके लिए ईमेल की सेटिंग चाहिए। फिर कोई एडमिन सर्वर सेटिंग में Sign in by email चालू करता है। यह डिफ़ॉल्ट रूप से बंद रहता है।
व्यक्ति Oleafly में Continue with Email चुनता है, ब्राउज़र में अपना पता भरता है और Email me a link चुनता है। लिंक एक बार, 15 मिनट तक, उसी कंप्यूटर पर काम करता है जिसने इसका निवेदन किया था। लिंक खोलने पर Sign in बटन वाला पेज दिखता है। सिर्फ़ खोलना लिंक को ख़त्म नहीं करता, इसलिए लिंक का पीछा करने वाला कोई मेल स्कैनर इसे ख़त्म नहीं कर सकता।
आपके एक्सेस नियम ही तय करते रहते हैं कि कौन अंदर आएगा: उस ईमेल पते के लिए अनुमति-सूची की प्रविष्टि, कोई डोमेन नियम या कोई अतिथि आमंत्रण। GitHub यूज़र नाम से बनी अनुमति-सूची की प्रविष्टि ईमेल लिंक से मेल नहीं खाती। सर्वर के पते को अंदर आने देने या न देने, दोनों ही स्थितियों में पेज एक ही बात कहता है, इसलिए कोई इससे यह नहीं पता लगा सकता कि किसका खाता है।
इसे चालू करने से मौजूदा खाते भी ईमेल लिंक के लिए खुल जाते हैं। लिंक उस खाते में साइन इन कराता है जिसके पास वह पता पहले से एक सत्यापित पते के रूप में है। सर्वर किसी खाते के लिए प्रोवाइडर द्वारा बताए गए हर सत्यापित पते को रखता है, सिर्फ़ मुख्य पते को नहीं, और व्यक्ति के उसे प्रोवाइडर से हटाने के बाद भी वह पता रखता है। जैसे GitHub अपने खाते का हर सत्यापित पता बताता है। इसलिए जो कोई भी इनमें से किसी पते की मेल पढ़ सकता है, वह ईमेल से उस खाते में साइन इन कर सकता है। इसे चालू करने से पहले जाँच लें कि लोग अपने खातों के हर पते पर अब भी नियंत्रण रखते हैं।
अगर कोई पता एक से ज़्यादा खातों से जुड़ा है, तो लिंक किसी भी खाते में साइन इन नहीं कराता। अगर उस पते वाला एकमात्र खाता निलंबित या हटाया गया है, तो लिंक से इनकार किया जाता है, जब तक आप उस व्यक्ति को वापस अंदर न आने दें।
सर्वर 15 मिनट में एक ईमेल पते पर सबसे ज़्यादा 3 लिंक और एक IP पते से 100 लिंक भेजता है, इसलिए एक ही पते वाली 50 लोगों की कक्षा के सब लोग साइन इन कर सकते हैं। OLEAFLY_EMAIL_LINKS_PER_ADDRESS और OLEAFLY_EMAIL_LINKS_PER_IP ये संख्याएँ बदलते हैं। एक /64 नेटवर्क के सारे IPv6 पते एक ही पता माने जाते हैं। Sign in by email बंद करने से पहले भेजे गए लिंक भी काम करना बंद कर देते हैं।
कोड से साइन इन करें
“कोड से साइन इन करें” शीर्षक वाला अनुभागजब ब्राउज़र साइन-इन के बाद Oleafly तक वापस नहीं पहुँच सकता, जैसे किसी प्रतिबंधित कंप्यूटर पर, तो लोग कोड से साइन इन कर सकते हैं। इसके लिए कोई सेटिंग नहीं चाहिए और यह सर्वर के हर साइन-इन विकल्प के साथ काम करता है।
Oleafly आपके सर्वर का पता /auth/device के साथ और आठ अक्षरों का एक कोड दिखाता है। व्यक्ति वह पता किसी भी फ़ोन या कंप्यूटर पर खोलता है, कोड टाइप करता है, पेज पर दिख रहे कंप्यूटर के नाम की पुष्टि करता है, और साइन इन करता है। साइन-इन उसी ब्राउज़र में पूरा होना चाहिए जहाँ उन्होंने कोड टाइप किया, इसलिए किसी और के भेजे हुए साइन-इन पेज के लिंक से कोई साइन इन नहीं होता।
कोड एक बार काम करता है, 10 मिनट बाद काम करना बंद कर देता है, और साइन-इन सिर्फ़ Oleafly की वही प्रति पूरी कर सकती है जिसने उसका निवेदन किया था। Stop, this wasn’t me उसे रद्द कर देता है। एक IP पता 10 मिनट में 100 कोड माँग सकता है और 10 ग़लत कोड टाइप कर सकता है। एक पता साझा करने वाली 50 लोगों की कक्षा के लिए इतना काफ़ी है, और OLEAFLY_DEVICE_CODES_PER_IP इसे बदलता है।
एक्सेस नियम
“एक्सेस नियम” शीर्षक वाला अनुभागसिर्फ़ साइन इन कर लेना अंदर आने के लिए काफ़ी नहीं है। कोई एक्सेस नियम उस व्यक्ति को अंदर आने की अनुमति देता है। एडमिन कंसोल में Access rules के नीचे इन्हें प्रबंधित करें:
- Allowed people: किसी व्यक्ति को ईमेल पते से या GitHub यूज़र नाम से जोड़ें, साथ में वह भूमिका जो उन्हें मिलेगी। यूज़र नाम सिर्फ़ GitHub के लिए काम करते हैं, क्योंकि दूसरे प्रोवाइडर लोगों को अपना नाम चुनने या बदलने देते हैं। अगर सर्वर ईमेल भेजता है, तो ईमेल पते से किसी को जोड़ने पर उन्हें सर्वर का पता और एक Add to Oleafly लिंक भेजा जाता है।
- Domains: किसी डोमेन, जैसे
cs.example.edu, के सत्यापित ईमेल पते वाले हर व्यक्ति को आपकी चुनी हुई भूमिका के साथ साइन इन करने दें।
एक बार आप लोगों को जोड़ देते हैं, तो वे Oleafly में सर्वर जोड़कर साइन इन कर सकते हैं।
People के नीचे आप किसी व्यक्ति की भूमिका बदल सकते हैं, उन्हें निलंबित या फिर से सक्रिय कर सकते हैं, हटा सकते हैं और उनके डिवाइस साइन आउट कर सकते हैं। निलंबित व्यक्ति का खाता बना रहता है, लेकिन आपके उसे फिर से सक्रिय करने तक वे सिंक नहीं कर सकते। उनके बदलाव उनके कंप्यूटर पर रहते हैं।
जिसे आप हटा देते हैं, वह बाहर रहता है, भले ही कोई डोमेन नियम उनके पते को कवर करता हो या कोई प्रोजेक्ट मालिक उन्हें अतिथि के रूप में आमंत्रित करे। उन्हें वापस अंदर आने देने के लिए उन्हें ईमेल पते या यूज़र नाम से फिर जोड़ें। उन्हें अपना पुराना खाता उसके सारे प्रोजेक्टों सहित वापस मिल जाता है।
खुला साइन-अप
“खुला साइन-अप” शीर्षक वाला अनुभागऐसे सर्वर के लिए जिसे कोई भी इस्तेमाल कर सके, OLEAFLY_OPEN_SIGNUP=true सेट करें और सर्वर रीस्टार्ट करें। फिर जो कोई भी आपके किसी प्रोवाइडर से साइन इन करता है, उसे Member भूमिका वाला खाता मिल जाता है, बिना अनुमत सूची की किसी प्रविष्टि या डोमेन नियम के। Sign in by email चालू हो, तो ईमेल लिंक भी इसी तरह काम करता है।
खुला साइन-अप फिर भी उन लोगों को बाहर रखता है जिन्हें आपने हटाया या निलंबित किया है, और हर उस व्यक्ति को जिसका सत्यापित पता किसी हटाए गए खाते का है। जब अतिथियों की अनुमति हो, तो अतिथि आमंत्रण वाला कोई व्यक्ति साइन इन करने पर सदस्य बन जाता है, और उसे वे प्रोजेक्ट फिर भी मिलते हैं जिनमें उसे आमंत्रित किया गया था।
यह हर खाते की सीमाएँ भी चालू कर देता है: जब तक आप दूसरे मान सेट न करें, हर खाता 100 MB तक रख सकता है, 50 साझा प्रोजेक्टों का मालिक हो सकता है और एक घंटे में 300 अपलोड कर सकता है।
एडमिन कंसोल यह नहीं दिखाता कि खुला साइन-अप चालू है या नहीं। सर्वर का लॉग हर बार शुरू होने पर यह बताता है: “Open sign-up is on, so anyone who signs in gets an account as a member.” प्रोजेक्ट साझा करते समय सदस्य एक-दूसरे को खोज सकते हैं, इसलिए खुले सर्वर पर सर्वर सेटिंग में Member directory बंद करने पर विचार करें।
भूमिकाएँ और अनुमतियाँ
“भूमिकाएँ और अनुमतियाँ” शीर्षक वाला अनुभागहर व्यक्ति की एक सर्वर भूमिका होती है, जो एडमिन और मेंटेनर देते हैं। जिस हर प्रोजेक्ट में उन्हें जोड़ा जाता है, उसमें उनकी एक प्रोजेक्ट भूमिका भी होती है, जो उस प्रोजेक्ट का मालिक देता है। भूमिकाएँ प्रोजेक्ट भूमिकाओं की सूची देती हैं: Owner, Editor, Reviewer, Commenter और Viewer।
कोई भी सर्वर भूमिका अपने आप में प्रोजेक्ट नहीं खोलती। प्रोजेक्ट का एक्सेस सिर्फ़ प्रोजेक्ट के मालिक से आता है।
| कार्रवाई | Admin | Maintainer | Member | Guest |
|---|---|---|---|---|
| Oleafly में सर्वर जोड़ना | हाँ | हाँ | हाँ | हाँ |
| सदस्य सूची देखना | हाँ | हाँ | हाँ, जब तक कोई एडमिन इसे छिपा न दे | नहीं |
| प्रोजेक्ट साझा करना | हाँ | हाँ | हाँ | नहीं |
| सुरक्षा लॉग पढ़ना | हाँ | हाँ | नहीं | नहीं |
| सर्वर में सदस्य जोड़ना | हाँ | हाँ | नहीं | नहीं |
| मेंटेनर नियुक्त करना | हाँ | नहीं | नहीं | नहीं |
| सर्वर सेटिंग बदलना | हाँ | नहीं | नहीं | नहीं |
| स्टोरेज खाली करने के लिए प्रोजेक्ट हटाना | हाँ | नहीं | नहीं | नहीं |
| किसी का डिवाइस साइन आउट करना | हाँ | हाँ, लेकिन दूसरे एडमिन या मेंटेनर के नहीं | सिर्फ़ अपने डिवाइस | सिर्फ़ अपने डिवाइस |
| सर्वर तक सीधी पहुँच से संग्रहीत प्रोजेक्ट पढ़ना | ऐप से नहीं | ऐप से नहीं | ऐप से नहीं | ऐप से नहीं |
आख़िरी पंक्ति सबसे ज़्यादा मायने रखती है। प्रोजेक्ट सर्वर पर एन्क्रिप्टेड नहीं होते, इसलिए जो कोई भी मशीन चलाता है, भूमिका चाहे जो भी हो, वह हर संग्रहीत प्रोजेक्ट पढ़ सकता है। Oleafly किसी भी भूमिका को, एडमिन को समेत, ऐप से ऐसा करने का कोई रास्ता नहीं देता। जब कोई एडमिन स्टोरेज खाली करने के लिए प्रोजेक्ट हटाता है, तो उसके मालिक और सदस्यों को बताया जाता है, और उनकी अपनी प्रतियाँ उनके कंप्यूटर पर बनी रहती हैं।
अतिथि वह होता है जो आपके सर्वर के बाहर से हो, जैसे किसी दूसरे विश्वविद्यालय का सह-लेखक, जिसे कोई प्रोजेक्ट मालिक किसी प्रोजेक्ट में आमंत्रित करता है। अतिथि सिर्फ़ वे प्रोजेक्ट देखते हैं जिनमें उन्हें आमंत्रित किया गया है।
अतिथियों को चालू करें
“अतिथियों को चालू करें” शीर्षक वाला अनुभागनए सर्वर पर अतिथि बंद रहते हैं। कोई एडमिन सर्वर सेटिंग में Allow guests से उन्हें चालू करता है। Approve guests first डिफ़ॉल्ट रूप से चालू रहता है, इसलिए हर आमंत्रण काम करने से पहले कोई एडमिन या मेंटेनर उसे स्वीकृत करता है। आमंत्रणों को तुरंत काम करने देने के लिए इसे बंद कर दें। जब कोई एडमिन या मेंटेनर ख़ुद आमंत्रण भेजता है, तो वह तुरंत स्वीकृत हो जाता है।
अगर आप बाद में Allow guests बंद कर देते हैं, तो मालिक नए आमंत्रण नहीं भेज सकते और बिना इस्तेमाल हुए आमंत्रण काम करना बंद कर देते हैं। जिन अतिथियों ने पहले ही साइन इन कर लिया है, वे तब तक अपने प्रोजेक्ट रखते हैं जब तक कोई मालिक उन्हें हटा न दे या आप उन्हें People के नीचे हटा न दें।
आमंत्रण
“आमंत्रण” शीर्षक वाला अनुभागकिसी प्रोजेक्ट में अतिथि को आमंत्रित सिर्फ़ उस प्रोजेक्ट का मालिक कर सकता है, प्रोजेक्ट के Share संवाद से।
- एक आमंत्रण एक पते और एक प्रोजेक्ट के लिए होता है, और 14 दिन बाद समाप्त हो जाता है।
- एक व्यक्ति एक घंटे में सबसे ज़्यादा 20 आमंत्रण भेज सकता है।
- जब अनुमोदन चालू हो, तो आमंत्रण People के सबसे ऊपर Pending guests के नीचे प्रतीक्षा करता है। एडमिन और मेंटेनर वहीं उसे स्वीकृत, अस्वीकृत या वापस ले सकते हैं। मालिक भी उसे वापस ले सकता है।
- अगर सर्वर ईमेल भेजता है और Email notifications चालू है, तो अतिथि को आमंत्रण का ईमेल मिलता है। वरना Oleafly मालिक को एक Add to Oleafly लिंक देता है जिसे वे ख़ुद भेज सकें।
- अगर प्रोजेक्ट में पहले से उतने लोग हैं जितने सर्वर अनुमति देता है, तो आमंत्रण प्रतीक्षा करता है, और किसी के जाने के बाद व्यक्ति के अगली बार साइन इन करने पर काम करता है।
अतिथि सर्वर जोड़ता है और किसी भी ऐसे विकल्प से साइन इन करता है जो सर्वर को आमंत्रित पता एक सत्यापित पते के रूप में दे: GitHub, कोई OpenID Connect प्रोवाइडर या ईमेल लिंक। असत्यापित पता गिना नहीं जाता। पहले साइन-इन से अतिथि खाता बनता है और जिन प्रोजेक्टों में वह पता आमंत्रित था, वे सब खुल जाते हैं।
अतिथि क्या कर सकते हैं
“अतिथि क्या कर सकते हैं” शीर्षक वाला अनुभागअतिथि जिन प्रोजेक्टों में आमंत्रित हैं उन्हें खोल और कंपाइल कर सकते हैं, भूमिका अनुमति देती हो तो उन्हें संपादित कर सकते हैं, और अपने डिवाइस साइन आउट कर सकते हैं। वे सदस्य निर्देशिका या किसी का ईमेल पता नहीं देख सकते, प्रोजेक्ट साझा नहीं कर सकते, दूसरों को आमंत्रित नहीं कर सकते, और न ही किसी प्रोजेक्ट के लिंक से उसमें शामिल हो सकते। किसी अतिथि को दूसरा प्रोजेक्ट देने के लिए उस प्रोजेक्ट का मालिक वही पता आमंत्रित करता है।
जब कोई अतिथि अपने आख़िरी प्रोजेक्ट से हटाया जाता है, या वह उसे छोड़ देता है, तो सर्वर उसका एक्सेस समाप्त कर देता है। वह खाता हटा देता है और हर डिवाइस साइन आउट कर देता है। नया आमंत्रण वही खाता वापस ले आता है। अगर आप किसी अतिथि को People के नीचे तब हटाते हैं जब उनके पास अभी प्रोजेक्ट बचे हैं, तो नया आमंत्रण उन्हें वापस नहीं ला सकता।
हटाया गया वापस नहीं आता
“हटाया गया वापस नहीं आता” शीर्षक वाला अनुभागजब कोई मालिक किसी को प्रोजेक्ट से हटाता है, अतिथि हो या न हो, तो वह व्यक्ति प्रोजेक्ट के लिंक से वापस नहीं आ सकता, भले ही लिंक साझाकरण चालू हो। हर कोशिश सुरक्षा लॉग में दिखती है। उन्हें वापस आने देने के लिए मालिक उन्हें फिर जोड़ता है, या अतिथि होने पर नया आमंत्रण भेजता है। जो कोई प्रोजेक्ट अपनी मर्ज़ी से छोड़ देता है, वह उसके लिंक से दोबारा शामिल हो सकता है।
ब्राउज़र से एक्सेस
“ब्राउज़र से एक्सेस” शीर्षक वाला अनुभागब्राउज़र से एक्सेस चालू होने पर लोग अपने साथ साझा किए गए प्रोजेक्ट Oleafly इंस्टॉल किए बिना किसी वेब ब्राउज़र में खोल सकते हैं। वे संपादन करते हैं, बदलाव सुझाते हैं, टिप्पणी करते हैं, चैट करते हैं और सबसे नई कंपाइल की गई PDF पढ़ते हैं। ब्राउज़र में काम करें बताता है कि उन्हें क्या दिखता है।
OLEAFLY_WEB=true सेट करें और सर्वर रीस्टार्ट करें। प्रकाशित कंटेनर इमेज में ब्राउज़र ऐप शामिल है। जिस बिल्ड में यह नहीं है, वह लॉग में लिखता है “OLEAFLY_WEB is true, but this build of Oleafly Server has no browser app, so browser access stays off.”
चालू होने के बाद:
- ब्राउज़र ऐप आपके सर्वर के पते के बाद
/web/पर होता है, जैसेhttps://collab.example.org/web/।/p/के नीचे हर प्रोजेक्ट के पेज पर एक Open in browser लिंक भी आ जाता है। - लोग
/web/sign-inपर उन्हीं प्रोवाइडरों और ईमेल लिंक से साइन इन करते हैं जो Oleafly में हैं, और वही एक्सेस नियम तय करते हैं कि कौन अंदर आए। ब्राउज़र 30 दिन तक साइन इन रहता है। - हर ब्राउज़र उस खाते के एक डिवाइस के रूप में गिना जाता है, “Safari on macOS” जैसे नाम के साथ। वह व्यक्ति की डिवाइस सूची में और सुरक्षा लॉग में दिखता है, और उसे साइन आउट करने से उस ब्राउज़र का सेशन खत्म हो जाता है।
- ब्राउज़र WebSocket से
/web/wsसे जुड़ता है और उसके पास कोई धीमा वैकल्पिक रास्ता नहीं है, इसलिए आपके प्रॉक्सी को वहाँ WebSocket अपग्रेड आगे जाने देने होंगे। Caddy, और रिवर्स प्रॉक्सी के पीछे में दिए nginx और Apache उदाहरण, यह पहले से करते हैं। - लोग जो PDF पढ़ते हैं, वह सबसे नई PDF है जो किसी मालिक या संपादक ने Oleafly में कंपाइल की। कंपाइल की गई PDF बताता है कि वह वहाँ कैसे पहुँचती है।
ब्राउज़र ऐप किसी दूसरी साइट के फ़्रेम के अंदर नहीं दिखाया जा सकता। लोगों की अवतार तस्वीरें लोड करने के अलावा वह केवल आपके सर्वर से जुड़ता है।
एडमिन कंसोल
“एडमिन कंसोल” शीर्षक वाला अनुभागएडमिन कंसोल Oleafly से एक सर्वर चलाने के लिए एक विंडो है। एडमिन और मेंटेनर इसे खोल सकते हैं। Settings → Collaboration में सर्वर के कार्ड पर Open admin console चुनें, या Manage server के सबसे ऊपर। हर सर्वर की अपनी अलग विंडो होती है।
| अनुभाग | यह क्या दिखाता और करता है |
|---|---|
| Overview | सर्वर स्वस्थ है या नहीं, उसके पास कितने लोग, डिवाइस और प्रोजेक्ट हैं, कौन ऑनलाइन है, वह कितना स्टोरेज इस्तेमाल कर रहा है, उसके ईमेल और साइन-इन विकल्प, और एक नज़र में उसकी सेटिंग। सर्वर के पास कोई साइन-इन विकल्प न होने पर यह Nobody can sign in चेतावनी देता है, और डेटा फ़ोल्डर में लिखा न जा सकने पर The server can’t save files। |
| People | जितने लोग साइन इन कर चुके हैं, सब। भूमिकाएँ बदलें, लोगों को निलंबित या हटाएँ, और उनके डिवाइस साइन आउट करें। स्वीकृति की प्रतीक्षा करते अतिथि आमंत्रण सबसे ऊपर रहते हैं। |
| Access rules | अनुमति-सूची और डोमेन नियम। |
| Projects | सर्वर पर साझा हर प्रोजेक्ट, उसके मालिक, उसमें कितने लोग, उसका आकार और उसकी आख़िरी गतिविधि के साथ। शीर्षक या मालिक से खोजें, सिर्फ़ साझा, आर्काइव या अपलोड हो रहे प्रोजेक्ट दिखाएँ, और किसी प्रोजेक्ट को आर्काइव करें या पुनर्स्थापित करें। |
| Settings | सर्वर सेटिंग। |
| ईमेल सेट हुआ है या नहीं, From पता और आख़िरी विफलता। यहीं से परीक्षण ईमेल भेजें। | |
| Security log | साइन-इन और इनकार किए गए साइन-इन, डिवाइस, लोग, सेटिंग, प्रोजेक्ट और अतिथि। हर प्रविष्टि बताती है कि किसने किया, कब और किस IP पते से, साथ में विवरण जैसे प्रोजेक्ट, इस्तेमाल में लिया गया साइन-इन विकल्प या साइन-इन से इनकार का कारण। |
| Connection checks | Test connection जैसी ही जाँचें, आपके कंप्यूटर से सर्वर तक चलाई जाती हैं। |
मेंटेनर हर अनुभाग इस्तेमाल कर सकते हैं, लेकिन वे किसी को एडमिन या मेंटेनर नहीं बना सकते, किसी दूसरे एडमिन या मेंटेनर के डिवाइस नहीं देख या साइन आउट कर सकते, स्टोरेज इस्तेमाल नहीं देख सकते, प्रोजेक्ट आर्काइव या पुनर्स्थापित नहीं कर सकते, सर्वर सेटिंग नहीं बदल सकते और परीक्षण ईमेल नहीं भेज सकते। एडमिन यह सब कर सकते हैं।
किसी प्रोजेक्ट को आर्काइव करने से सबके लिए उसकी साझाकरण बंद हो जाती है। लोग उसे सिंक करना बंद कर देते हैं और अपनी प्रतियाँ रखते हैं, और सर्वर उसे OLEAFLY_ARCHIVE_DAYS दिनों बाद हटा देता है, जब तक कोई एडमिन पहले उसे पुनर्स्थापित न कर दे। पुनर्स्थापना उसे उन्हीं लोगों के साथ फिर साझा कर देती है। जिस प्रोजेक्ट का पहला अपलोड कभी पूरा नहीं हुआ, वह पुनर्स्थापित नहीं हो सकता। दोनों सुरक्षा लॉग में दिखते हैं।
कंसोल कभी कोई प्रोजेक्ट नहीं खोलता। वह शीर्षक, मालिक और आकार दिखाता है, उनके भीतर की कोई चीज़ नहीं।
सर्वर सेटिंग
“सर्वर सेटिंग” शीर्षक वाला अनुभागये सर्वर पर हर किसी पर लागू होती हैं। सिर्फ़ एडमिन इन्हें बदल सकते हैं।
| सेटिंग | यह क्या करती है |
|---|---|
| Allow guests | सदस्य अपने प्रोजेक्टों में सर्वर के बाहर के लोगों को आमंत्रित कर सकते हैं। |
| Approve guests first | हर अतिथि आमंत्रण काम करने से पहले कोई मेंटेनर या एडमिन उसे स्वीकृत करता है। |
| Member directory | प्रोजेक्ट साझा करते समय सदस्य एक-दूसरे को नाम से खोज सकते हैं। |
| Show email addresses in the directory | किसी को खोजने पर सदस्य एक-दूसरे के ईमेल पते देखते हैं। |
| Allow link sharing | प्रोजेक्ट मालिक किसी भी सदस्य को प्रोजेक्ट के लिंक से उसे खोलने दे सकते हैं। |
| Allow public note links | सदस्य किसी नोट की केवल-पढ़ने वाली प्रति ऐसे लिंक पर प्रकाशित कर सकते हैं जिसे कोई भी बिना साइन इन किए खोल सकता है। यह डिफ़ॉल्ट रूप से बंद है। इसे बंद करने पर हर प्रकाशित लिंक तब तक रुक जाता है जब तक आप इसे फिर चालू न करें। केवल-पढ़ने वाली प्रति प्रकाशित करें देखें। |
| Allow project access logs | प्रोजेक्ट मालिक यह लॉग रख सकते हैं कि किसने उनका प्रोजेक्ट खोला। |
| Allow comments | साझा प्रोजेक्टों के लोग टेक्स्ट पर टिप्पणी कर सकते हैं और जवाब दे सकते हैं। इसे बंद करने से टिप्पणियाँ हर जगह छिप जाती हैं और संग्रहीत बनी रहती हैं। |
| Email notifications | साइन-इन लिंक को छोड़कर सर्वर के सारे ईमेल सबके लिए बंद करने के लिए इसे बंद कर दें। |
| Sign in by email | लोग उनके ईमेल पते पर भेजे गए लिंक से साइन इन कर सकते हैं। इसके लिए सर्वर की ईमेल सेटिंग चाहिए। |