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

Umami को एक प्राइवेसी-फर्स्ट एनालिटिक्स प्लेटफॉर्म के रूप में प्रस्तुत किया गया है जो ट्रैफिक, कैंपेन, व्यवहार, कन्वर्जन और राजस्व को एक ही स्थान पर लाता है। प्रोजेक्ट इस बात पर जोर देता है कि यह कुकीज़ या निगरानी तकनीकों का उपयोग नहीं करता है, और इसे या तो सेल्फ-होस्ट किया जा सकता है या होस्टेड क्लाउड ऑफरिंग के माध्यम से संचालित किया जा सकता है। README से एक पब्लिक डेमो लिंक किया गया है, और प्रोजेक्ट सपोर्ट चैनलों में GitHub, Twitter, LinkedIn और Discord शामिल हैं। कोड को MIT लाइसेंस के तहत जारी किया गया है। सोर्स से इंस्टॉलेशन के लिए Node.js 18.18 या उसके बाद के संस्करण और PostgreSQL डेटाबेस (वर्जन 12.14 या उसके बाद का) वाले सर्वर की आवश्यकता होती है। प्रलेखित प्रक्रिया रिपॉजिटरी को क्लोन करने, pnpm के साथ डिपेंडेंसी इंस्टॉल करने, `DATABASE_URL` कनेक्शन स्ट्रिंग वाली एक `.env` फ़ाइल बनाने, बिल्ड चलाने और फिर एप्लिकेशन शुरू करने की है। बिल्ड स्टेप पहले इंस्टॉलेशन पर डेटाबेस टेबल बनाता है और `admin` यूजरनेम और `umami` पासवर्ड के साथ एक लॉगिन यूजर भी सीड करता है। डिफ़ॉल्ट रूप से ऐप `http://localhost:3000` पर शुरू होता है, इसलिए डॉक्यूमेंटेशन में उल्लेख है कि आपको आमतौर पर वेब सर्वर से अनुरोधों को प्रॉक्सी करने या इसे सीधे सर्व करने के लिए पोर्ट बदलने की आवश्यकता होगी। कई एनवायरनमेंट विकल्प प्रलेखित हैं। `API_URL` आंतरिक UI API कॉल्स के लिए उपयोग किए जाने वाले बेस URL को बदल सकता है; रिलेटिव पाथ `BASE_PATH` के तहत सर्व किए जाते हैं, जबकि एब्सोल्यूट URL स्थानीय `/api` रूट के माध्यम से प्रॉक्सी किए जाते हैं। `TWO_FACTOR_ENCRYPTION_KEY`, जो उदाहरण के लिए `openssl rand -hex 32` के साथ जेनरेट की गई 64-कैरेक्टर हेक्स स्ट्रिंग है, टू-फैक्टर ऑथेंटिकेशन को सक्षम करती है; जब तक इसे सेट नहीं किया जाता, टू-फैक्टर ऑथेंटिकेशन अनुपलब्ध रहता है और इसे अनिवार्य नहीं किया जा सकता। कंटेनराइज्ड डिप्लॉयमेंट के लिए, प्रोजेक्ट Docker इमेजेस प्रकाशित करता है और एक Docker compose फ़ाइल प्रदान करता है जो PostgreSQL डेटाबेस के साथ Umami को चलाता है। अपडेट को या तो सोर्स पुल करने, डिपेंडेंसी फिर से इंस्टॉल करने और रीबिल्ड करने के माध्यम से, या नई इमेजेस पुल करने और Docker compose के साथ कंटेनरों को फिर से बनाने के माध्यम से संभाला जाता है। एक विस्तृत गेटिंग-स्टार्टेड गाइड प्रोजेक्ट की डॉक्यूमेंटेशन साइट पर होस्ट की गई है।