كيفية إعداد نسختك الخاصة من NodeGoat

الخيار 1 - تشغيل NodeGoat على جهازك

1. قم بتثبيت Node.js - يتطلب NodeGoat إصدار Node v8 أو أعلى

2. استنسخ مستودع GitHub:

   root@kitploit:~

   git clone https://github.com/OWASP/NodeGoat.git
   

3. انتقل إلى الدليل:

   root@kitploit:~

   cd NodeGoat
   

4. قم بتثبيت حزم Node:

   root@kitploit:~

   npm install
   

5. قم بإعداد MongoDB. يمكنك إما تثبيت MongoDB محليًا أو إنشاء مثيل بعيد:

   • استخدام MongoDB محلي:

     1. قم بتثبيت MongoDB Community Server
     2. ابدأ mongod

   • استخدام مثيل MongoDB بعيد:

     1. انشر كتلة MongoDB Atlas مجانية المستوى (M0 Sandbox)
     2. فعّل الوصول إلى الشبكة للكتلة من عنوان IP الحالي الخاص بك
     3. أضف مستخدم قاعدة بيانات إلى الكتلة
     4. قم بتعيين متغير البيئة MONGODB_URI إلى سلسلة الاتصال الخاصة بالكتلة، والتي يمكن عرضها في حوار الاتصال للكتلة. اختر "Connect your application"، واضبط المحرك على "Node.js" والإصدار على "2.2.12 or later". سيعطيك هذا سلسلة اتصال بالشكل:
        root@kitploit:~

        mongodb://<username>:<password>@<cluster>/<dbname>?ssl=true&replicaSet=<rsname>&authSource=admin&retryWrites=true&w=majority
        

        يجب ملء حقول <username> و <password> بتفاصيل مستخدم قاعدة البيانات المضاف سابقًا. حقل <dbname> يحدد اسم قاعدة البيانات التي سيستخدمها nodegoat في الكتلة (مثل "nodegoat"). سيتم ملء الحقول الأخرى بالفعل بالتفاصيل الصحيحة للكتلة الخاصة بك.

6. قم بتعبئة MongoDB بالبيانات الأولية المطلوبة للتطبيق:

   root@kitploit:~

   npm run db:seed
   

   افتراضيًا، سيستخدم هذا التكوين "development"، ولكن يمكن تمرير التكوين المطلوب كوسيطة إذا لزم الأمر.

7. ابدأ الخادم. يمكنك تشغيل الخادم باستخدام node أو nodemon:

   • ابدأ الخادم باستخدام node. هذا يبدأ تطبيق NodeGoat على http://localhost:4000/:
     root@kitploit:~

     npm start
     

   • ابدأ الخادم باستخدام nodemon، والذي سيعيد تشغيل التطبيق تلقائيًا عند إجراء أي تغييرات. هذا يبدأ تطبيق NodeGoat على http://localhost:5000/:
     root@kitploit:~

     npm run dev
     

تخصيص إعدادات التطبيق الافتراضية

افتراضيًا، سيتم استضافة التطبيق على المنفذ 4000 وسيتصل بمثيل MongoDB على localhost:27017. لتغيير ذلك، قم بتعيين متغيرات البيئة PORT و MONGODB_URI.

يمكن تغيير الإعدادات الأخرى عن طريق تحديث ملف التكوين.

الخيار 2 - تشغيل NodeGoat على Docker

يتضمن المستودع ملف Dockerfile و docker-compose.yml اللازمين لإعداد التطبيق ومثيل قاعدة البيانات، ثم ربطهما معًا.

1. قم بتثبيت docker و docker compose

2. استنسخ مستودع GitHub:

   root@kitploit:~

   git clone https://github.com/OWASP/NodeGoat.git
   

3. انتقل إلى الدليل:

   root@kitploit:~

   cd NodeGoat
   

4. قم ببناء الصور:

   root@kitploit:~

   docker-compose build
   

5. شغّل التطبيق، هذا يبدأ تطبيق NodeGoat على http://localhost:4000/:

   root@kitploit:~

   docker-compose up
   

الخيار 3 - النشر على Heroku

يستخدم هذا الخيار خادم Heroku مجاني ($0/شهر).

على الرغم من أنه ليس ضروريًا، إلا أنه يُوصى بعمل fork لهذا المستودع ونشر المستودع المُفورك. سيسمح لك هذا بإصلاح الثغرات في نسختك المفوركة، ثم نشرها واختبارها على Heroku.

1. قم بإعداد مثيل MongoDB عام الوصول:

   1. انشر كتلة MongoDB Atlas مجانية المستوى (M0 Sandbox)
   2. فعّل الوصول إلى الشبكة للكتلة من أي مكان (نطاق CIDR 0.0.0.0/0)
   3. أضف مستخدم قاعدة بيانات إلى الكتلة

2. انشر NodeGoat على Heroku بالضغط على الزر أدناه:

   

   في مربع حوار Create New App، قم بتعيين المتغير التكويني MONGODB_URI إلى سلسلة الاتصال الخاصة بكتلة MongoDB Atlas الخاصة بك. يمكن عرض ذلك في حوار الاتصال للكتلة. اختر "Connect your application"، واضبط المحرك على "Node.js" والإصدار على "2.2.12 or later". سيعطيك هذا سلسلة اتصال بالشكل:

   root@kitploit:~

   mongodb://<username>:<password>@<cluster>/<dbname>?ssl=true&replicaSet=<rsname>&authSource=admin&retryWrites=true&w=majority
   

   يجب ملء حقول <username> و <password> بتفاصيل مستخدم قاعدة البيانات المضاف سابقًا. حقل <dbname> يحدد اسم قاعدة البيانات التي سيستخدمها nodegoat في الكتلة (مثل "nodegoat"). سيتم ملء الحقول الأخرى بالفعل بالتفاصيل الصحيحة للكتلة الخاصة بك.

الإبلاغ عن الأخطاء، الملاحظات، التعليقات

• افتح issue جديدًا أو اتصل بالفريق من خلال الانضمام إلى الدردشة على Slack أو

المساهمة

يرجى اتباع دليل المساهمة

مدونة السلوك (CoC)

هذا المشروع ملزم بـ مدونة السلوك.

المساهمون

هنا المساهمون الرائعون في مشروع NodeGoat.

الدعم

• شكرًا لـ JetBrains على توفير تراخيص لـ بيئة WebStorm IDE الرائعة لبناء هذا المشروع.

الرخصة

الكود مرخص بموجب رخصة Apache v2.0.