أداة مقارنة مفتاحية بين .env و .env.example
مرشد
أداة مقارنة مفتاحية بين .env و .env.example
الانحراف بين ما هو واقعي .env ملف و .env.example الملف هو أحد أضعف مصادر الأخطاء في الإطلاق. تُضاف المفاتيح أثناء التطوير، وتُنسخ إلى الإنتاج، ثم تُنسى في الملف النموذجي. تبقى القيم المُستخدمة كمُستعارات في .env حيث كان يجب أن تُوضع الأسرار الحقيقية. يُمكن لهذا الأداة ترتيب الملفين بجانب بعضهما البعض ويُعطي تقريرًا مصنفًا يوضح ما هو مفقود، مُضاف، أو غير مطابق، بحيث يمكنك تسوية انحرافات التكوين قبل أن يُطلق.
تتم جميع عمليات التحليل بالكامل في المتصفح. لا يغادر أي شيء الذي تلصقه جهازك، ويمكنك اختيار إخفاء كل قيمة في تقرير الشاشة أو الملف المُصدر بحيث لا تتسرب الأسرار في الصور أو التقارير المُشاركة.
كيفية استخدام
- لصق محتوى الملف
.env.exampleفي المدخل الأيسر. - لصق محتوى الملف الحقيقي
.envفي المدخل الأيمن. - قم بتعديل الخيارات إذا لزم الأمر. احتفظ إخفاء القيم مُفعّل عند العمل مع أسرار حقيقية.
- راجع الأحجار المجمعة في الأعلى: المطابقة، المفقودة، المُضاف، وانحراف القيم.
- قم بفحص كل قسم مصنف لرؤية أي مفتاح يقع في كل مربع.
- انقر ينسخ أو تحميل الوصول إلى تقرير القابل للتصدير لمشاركة النتيجة مع فريقك أو إضافتها إلى قائمة الإطلاق.
خصائص
- مُقارنة مصنفة – مُستندات مفقودة، مُضاف، غير مطابقة، ومطابقة منفصلة.
- مُقارنة القيم – يُحدد المفاتيح التي تُستخدم فيها قيمة المثال ولكن تختلف عن القيمة الحقيقية.
- مفتاح الحساسية للحالة – إيقاف التبديل لاعتبار
DB_HOSTوdb_hostمفتاحًا واحدًا. - إخفاء القيم – إخفاء الأسرار الحقيقية في التقرير بحيث تبقى الصور والتصاميم آمنة.
- مُحلل مُدرك للحالات الطرفية – يتعامل مع التعليقات، السطور الفارغة، القيم المُقتطعة، و
exportالسلاسل المُقدمة. - نسخ / تحميل التقرير – تقرير نصي جاهز للاستخدام في تعليق في الطلب، أو دليل الإطلاق، أو ملخص الحادث.
- من جانب العميل فقط – لا يتم إرسال القيم إلى أي مكان.
متى يجب استخدام هذه الأداة؟
- عند تدريب مطوّر جديد وتأكيد أن ما هو موجود محليًا
.envيُطابق الملف النموذجي الحالي. - عند إعداد الإطلاق وتأكيد أن التكوين في الإنتاج يغطي كل المتغيرات المطلوبة.
- عند تشغيل ميزة تفشل بشكل سكين لأن المفتاح المطلوب لم يُضاف إلى البيئة.
- عند مراجعة خدمة قديمة حيث
.env.exampleأصبحت غير متوافقة مع الواقع.
التعليمات
-
ما الفرق بين ملف .env وملف .env.example؟
يحتوي ملف .env على القيم الحقيقية للمتغيرات البيئية التي تستخدمها التطبيقات (كلمات المرور للقواعد البيانات، مفاتيح الـ API، الأسرار) ويُعتبر عادةً مُستبعدًا من التحكم في الإصدار. يحتوي ملف .env.example على نموذج مُقدّم إلى المخزن ويُدرج جميع المتغيرات المطلوبة مع قيم مُستعارة أو فارغة. يُخبر المطورين الجدد بالمتغيرات التي يجب أن يُعدّوها دون إظهار الأسرار الحقيقية.
-
لماذا يجب ألا يُُدرج المتغيرات البيئية في المخزن؟
تُحتوي المتغيرات البيئية غالبًا على أسرار مثل بيانات قواعد البيانات، مفاتيح الـ API، مفاتيح التشفير الخاصة، وأسرار الجلسات. إذا تم إدراجها، فإنها تُظهر في سجلات جيت إلى الأبد ويمكن أن تُستخرج من قبل البوتات التي تبحث عن المخازن العامة. حتى المخازن الخاصة تزيد من مساحة الهجوم لأن أي شخص لديه صلاحية القراءة يحصل على أسرار الإنتاج. الممارسة المقبولة هي الحفاظ على القيم الحقيقية خارج التحكم في الإصدار ومشاركة نموذج مُنظف مثل .env.example بدلًا من ذلك.
-
كيف يتم تحليل ملفات .env بواسطة التطبيقات؟
تقرأ معظم مُحللات .env الملف خطًا بخط، تتجاهل السطور الفارغة والسطور التي تبدأ بـ '#'، وتُقسم السطور المتبقية على الرمز الأول '=' لإنتاج مفتاح وقيمة. يمكن أن تُحتفظ القيم المُقتطعة لحفظ الفراغات أو الرموز الخاصة، وتعمل العديد من المُحللات أيضًا على الاحتفاظ بـ 'export ' المُسبقة لتوافق الشاشة. تُعتبر الحالات الطرفية مثل التعليقات المُتالية للقيمة، المفاتيح المتكررة، والتمثيل النصي من بين الحالات التي يمكن أن تختلف بين المكتبات.
-
ماذا يحدث عندما يفتقر المتغير البيئي المطلوب أثناء التشغيل؟
يعتمد السلوك على التطبيق. تُحقق التطبيقات المُصممة جيدًا من المتغيرات المطلوبة عند بدء التشغيل وتُظهر خطأ واضح. قد تُقرأ المُسارات الضعيفة المتغيرات غير المعرفة كسلسلة فارغة، مما يؤدي إلى إيقاف الميزات بشكل سكين، أو تفعيل تجاوز التحقق، أو تسبب أخطاء غير متعلقة في طبقة المكالمة. مقارنة ملف .env مع .env.example قبل الإطلاق هي طريقة بسيطة للكشف عن التكوين المفقود قبل أن يُصل إلى الإنتاج.
تثبيت ملحقاتنا
أضف أدوات IO إلى متصفحك المفضل للوصول الفوري والبحث بشكل أسرع
恵 وصلت لوحة النتائج!
لوحة النتائج هي طريقة ممتعة لتتبع ألعابك، يتم تخزين جميع البيانات في متصفحك. المزيد من الميزات قريبا!
