password protected website template

Vorlage für eine verschlüsselte Single-Page-Website

Mit diesem Vorlagen-Repository können Sie ganz einfach eine passwortgeschützte Seite erstellen, die auf Github-Seiten gehostet wird. Dies kann für Informationen oder Veranstaltungen nützlich sein, die nicht für jedermann zugänglich sein sollen, z. B. für Ihren Geburtstag, Ihre Hochzeit oder eine Firmenveranstaltung.

Um die Demo zu überprüfen, verwenden Sie den test .

Haftungsausschluss : Bitte beachten Sie, dass ich (oder die Abhängigkeiten) möglicherweise etwas übersehen habe. Gehen Sie also nicht davon aus, dass dies kugelsicher ist. Geben Sie auf diese Weise keine Bankdaten oder Ähnliches weiter.

Verwendung

• Erstellen Sie ein Repository aus einer Vorlage, indem Sie auf die Schaltfläche use this template klicken
• Wählen Sie einen Repository-Namen aus (Ihre URL lautet {GITHUB-ACCOUNT-NAME}.github.io/{REPOSITORY-NAME} ).
• Wählen Sie das Repository als privat aus, wenn Sie nicht möchten, dass Personen ohne Passwort auf den Inhalt zugreifen können
• Erstellen Sie ein Github-Geheimnis mit dem Namen DECRYPTION_PASSPHRASE und legen Sie den value auf Ihr gewünschtes Passwort fest (beachten Sie, dass die CI-Pipeline aufgrund des fehlenden Passworts beim ersten Versuch fehlschlägt).
• Legen Sie die Veröffentlichungsquelle auf den main fest, um das Hosting mit Github Pages zu aktivieren

So passen Sie die Website an:

• Sie können die Anmeldeseite anpassen

  • Passen Sie encrypt_with_assets.yml an, also den Schritt „Index verschlüsseln“, um den Titel, die Anweisungen und den Namen der Schaltfläche festzulegen

    - 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"

  • Einzelheiten und Informationen zum Ändern des vollständigen Layouts finden Sie unter StatiCrypt

• Bearbeiten Sie die main.html , die den Besuchern nach der Verschlüsselung angezeigt wird (die verschlüsselte Version, die gehostet wird, ist index.html ).

  • Assets können wie gewohnt genutzt werden und werden nicht verschlüsselt

Verschlüsselte Vermögenswerte

Standardmäßig ist die Verschlüsselung von Assets aktiviert, da der Workflow encrypt_with_assets.yml aktiv ist. Beachten Sie, dass dadurch nur alle direkt verknüpften Bilder, CSS- und JavaScript-Dateien im HTML-Dokument durch eine direkte Base64-Darstellung ersetzt werden. Daher funktionieren Ihre relativen Links in Dateien wahrscheinlich nicht mehr, da sich ihr Speicherort geändert hat.

Wenn Sie keine Vermögenswerte verschlüsseln möchten

• Entfernen Sie den Asset-Ordner aus den exclude s der _config.yml .
• encrypt_with_assets.yml zu encrypt_with_assets._yml und
• Benennen Sie encrypt_without_assets._yml in encrypt_with_assets.yml

Lokale Nutzung

Wenn Sie keine Ihrer Daten (noch) in einem privaten Repository haben möchten, können Sie diese auch lokal konvertieren und erst anschließend die index.html hochladen. Gehen Sie dazu folgendermaßen vor:

• Erstellen Sie das Bild

   docker build -t ppw .
  

• Führen Sie die Verschlüsselung aus

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

• Ignorieren Sie Änderungen an main.html

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

  Gegebenenfalls gilt das Gleiche auch für Ihr Vermögen.

Credits

• Die Verschlüsselung erfolgt durch StatiCrypt: MIT-Lizenz
• Als Basis nutzen wir den Workflow von staticrypt-github-actions: MIT-Lizenz
• Wir verwenden Bootstrap, einschließlich eines ihrer Beispiele (Demo): MIT-Lizenz
• Wir verwenden Code von Six-Four, um Bild-MIME-Typen zu bestimmen: MIT-Lizenz
• Wir verwenden das Github CSS Ribbon: MIT-Lizenz