منصوبے کے بارے میں

Umami کو ایک پرائیویسی فرسٹ اینالیٹکس پلیٹ فارم کے طور پر پیش کیا گیا ہے جو ٹریفک، مہمات، رویے، تبدیلیوں اور آمدنی کو ایک جگہ جمع کرتا ہے۔ پروجیکٹ اس بات پر زور دیتا ہے کہ یہ کوکیز یا نگرانی کی تکنیکوں کا استعمال نہیں کرتا، اور اسے یا تو سیلف ہوسٹڈ یا ہوسٹڈ کلاؤڈ پیشکش کے ذریعے چلایا جا سکتا ہے۔ README سے ایک عوامی ڈیمو لنک کیا گیا ہے، اور پروجیکٹ سپورٹ چینلز میں GitHub، Twitter، LinkedIn اور Discord شامل ہیں۔ کوڈ MIT لائسنس کے تحت جاری کیا گیا ہے۔ سورس سے انسٹالیشن کے لیے Node.js 18.18 یا اس کے بعد کے ورژن اور PostgreSQL ڈیٹا بیس (ورژن 12.14 یا اس کے بعد) والے سرور کی ضرورت ہوتی ہے۔ دستاویزی طریقہ کار یہ ہے کہ ریپوزٹری کو کلون کریں، pnpm کے ساتھ ڈیپینڈنسز انسٹال کریں، ایک `.env` فائل بنائیں جس میں `DATABASE_URL` کنکشن سٹرنگ ہو، بلڈ رن کریں، اور پھر ایپلی کیشن شروع کریں۔ بلڈ مرحلہ پہلی انسٹالیشن پر ڈیٹا بیس ٹیبلز بناتا ہے اور `admin` صارف نام اور `umami` پاس ورڈ کے ساتھ ایک لاگ ان صارف بھی بناتا ہے۔ ڈیفالٹ طور پر ایپ `http://localhost:3000` پر شروع ہوتی ہے، اس لیے دستاویزات میں نوٹ کیا گیا ہے کہ آپ کو عام طور پر ویب سرور سے درخواستوں کو پراکسی کرنے یا اسے براہ راست فراہم کرنے کے لیے پورٹ تبدیل کرنے کی ضرورت ہوگی۔ کئی ماحول کے اختیارات (environment options) دستاویزی ہیں۔ `API_URL` اندرونی UI API کالز کے لیے استعمال ہونے والے بیس URL کو تبدیل کر سکتا ہے؛ رشتہ دار راستے (relative paths) `BASE_PATH` کے تحت فراہم کیے جاتے ہیں، جبکہ مطلق URLs مقامی `/api` روٹ کے ذریعے پراکسی کیے جاتے ہیں۔ `TWO_FACTOR_ENCRYPTION_KEY`، جو کہ ایک 64-کردار کا ہیکس سٹرنگ ہے (مثال کے طور پر `openssl rand -hex 32` کے ذریعے تیار کیا گیا)، ٹو-فیکٹر کی تصدیق کو فعال کرتا ہے؛ جب تک اسے سیٹ نہیں کیا جاتا، ٹو-فیکٹر کی تصدیق دستیاب نہیں ہوتی اور اسے لازمی نہیں بنایا جا سکتا۔ کنٹینرائزڈ تعیناتی کے لیے، پروجیکٹ Docker امیجز شائع کرتا ہے اور ایک Docker compose فائل فراہم کرتا ہے جو Umami کو PostgreSQL ڈیٹا بیس کے ساتھ چلاتا ہے۔ اپ ڈیٹس یا تو سورس پُل کرنے، ڈیپینڈنسز دوبارہ انسٹال کرنے اور دوبارہ بلڈ کرنے کے ذریعے، یا نئی امیجز پُل کرنے اور Docker compose کے ساتھ کنٹینرز کو دوبارہ بنانے کے ذریعے سنبھالے جاتے ہیں۔ ایک تفصیلی گائیڈ پروجیکٹ کی دستاویزات کی سائٹ پر موجود ہے۔