password protected website template

قالب لموقع ويب مشفر بصفحة واحدة

يسهّل مستودع القوالب هذا إنشاء صفحة محمية بكلمة مرور تتم استضافتها على صفحات Github. يمكن أن يكون هذا مفيدًا للمعلومات أو الأحداث التي لا ينبغي أن تكون متاحة للجميع، على سبيل المثال، عيد ميلادك أو حفل زفافك أو حدث خاص بالشركة.

للتحقق من العرض التوضيحي، استخدم test كلمة المرور.

إخلاء المسؤولية : يرجى العلم أنني (أو التبعيات) ربما فاتني شيء ما، لذا لا تفترض أن هذا دليل على الرصاص. لا تشارك المعلومات المصرفية أو ما شابه ذلك بهذه الطريقة.

الاستخدام

• قم بإنشاء مستودع من قالب بالنقر فوق الزر use this template .
• حدد اسم المستودع (سيكون عنوان URL الخاص بك هو {GITHUB-ACCOUNT-NAME}.github.io/{REPOSITORY-NAME} )
• اختر المستودع ليكون خاصًا ، إذا كنت لا تريد أن يتمكن الأشخاص من الوصول إلى المحتويات دون كلمة المرور
• قم بإنشاء سر Github باسم DECRYPTION_PASSPHRASE وقم بتعيين value على كلمة المرور المطلوبة (لاحظ أن خط أنابيب CI سيفشل في المحاولة الأولى بسبب كلمة المرور المفقودة)
• اضبط مصدر النشر على الفرع main لتفعيل الاستضافة مع Github Pages

لتخصيص موقع الويب:

• يمكنك تخصيص صفحة تسجيل الدخول

  • اضبط encrypt_with_assets.yml، أي خطوة "تشفير الفهرس" لتعيين العنوان والتعليمات واسم الزر

    - name : Encrypt index
      run : >
        staticrypt index.html -p ${{ secrets.DECRYPTION_PASSPHRASE }} --short
        --template "password_template.html"
        --template-title "Login"
        --template-instructions "This is a test website, use the password 'test' to enter."
        --template-button "Open Page"
        --template-color-primary "#113e9f"
        --template-color-secondary "#e4e4e4"

  • للحصول على التفاصيل ولتغيير التخطيط الكامل، راجع StatiCrypt

• قم بتحرير main.html الذي سيظهر للزوار بعد التشفير (النسخة المشفرة المستضافة هي index.html )

  • يمكن استخدام الأصول كالمعتاد ولن يتم تشفيرها

الأصول المشفرة

افتراضيًا، يتم تمكين تشفير الأصول، نظرًا لأن سير العمل encrypt_with_assets.yml نشط. لاحظ أن هذا يستبدل فقط جميع الصور المرتبطة مباشرة وملفات CSS وJavaScript في مستند HTML بتمثيل Base64 في مكانه. وبالتالي، من المحتمل ألا تعمل الروابط النسبية في الملفات بعد الآن، نظرًا لتغير موقعها.

إذا كنت لا تريد تشفير الأصول

• قم بإزالة مجلد الأصول من exclude _config.yml ،
• encrypt_with_assets.yml إلى encrypt_with_assets._yml و
• أعد تسمية encrypt_without_assets._yml إلى encrypt_with_assets.yml

الاستخدام المحلي

إذا كنت لا تريد الاحتفاظ بأي من بياناتك (حتى) في مستودع خاص، فيمكنك أيضًا تحويلها محليًا وتحميل index.html بعد ذلك فقط. للقيام بذلك، اتبع الخطوات التالية:

• بناء الصورة

   docker build -t ppw .
  

• قم بتشغيل التشفير

   docker run -it --rm --name ppw -e PASSWORD=test --mount type=bind,source=${PWD},target=/code ppw
  

• تجاهل التغييرات في main.html

   git update-index --skip-worktree main.html
  

  بشكل اختياري، نفس الشيء مطلوب للأصول الخاصة بك.

الاعتمادات

• يتم التشفير بواسطة StatiCrypt: ترخيص MIT
• نحن نستخدم سير العمل من إجراءات staticrypt-github كأساس: ترخيص MIT
• نحن نستخدم Bootstrap، بما في ذلك أحد الأمثلة (عرض توضيحي): ترخيص MIT
• نستخدم الكود من ستة إلى أربعة لتحديد أنواع MIME للصور: ترخيص MIT
• نحن نستخدم شريط Github CSS: ترخيص MIT