password protected website template

暗号化された単一ページ Web サイトのテンプレート

このテンプレート リポジトリを使用すると、Github ページでホストされるパスワードで保護されたページを簡単に作成できます。これは、誕生日、結婚式、企業イベントなど、誰にでも公開すべきではない情報やイベントに役立ちます。

デモを確認するには、パスワードtestを使用します。

免責事項: 私 (または依存関係) が何かを見逃している可能性があることに注意してください。そのため、これが完璧であるとは考えないでください。この方法で銀行情報などを共有しないでください。

使用法

• use this templateボタンをクリックして、テンプレートからリポジトリを作成します。
• リポジトリ名を選択します (URL は{GITHUB-ACCOUNT-NAME}.github.io/{REPOSITORY-NAME}になります)
• パスワードなしでコンテンツにアクセスできないようにする場合は、リポジトリを非公開にすることを選択します。
• DECRYPTION_PASSPHRASEという名前の Github シークレットを作成し、そのvalue目的のパスワードに設定します (パスワードが欠落しているため、CI パイプラインは最初の試行で失敗することに注意してください)
• Github Pages でのホスティングを有効にするために、公開ソースをmainブランチに設定します。

Web サイトをカスタマイズするには:

• ログインページをカスタマイズできます

  • 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がアクティブであるため、デフォルトではアセットの暗号化が有効になっています。これは、HTML ドキュメント内のすべての直接リンクされた画像、CSS、および JavaScript ファイルをインプレースの Base64 表現に置き換えるだけであることに注意してください。したがって、ファイル内の相対リンクは、場所が変更されたためおそらく機能しなくなります。

資産を暗号化したくない場合

• _config.ymlのexcludeからアセットフォルダーを削除します。
• 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-actions のワークフローをベースとして使用します: MIT ライセンス
• 私たちは例 (デモ) の 1 つを含む Bootstrap を使用しています: MIT License
• 画像の MIME タイプを決定するために 6-4 のコードを使用します: MIT ライセンス
• Github CSS リボン: MIT ライセンスを使用します。