password protected website template

加密單頁網站模板

此範本儲存庫可以輕鬆建立託管在 Github 頁面上的受密碼保護的頁面。這對於並非每個人都可以獲得的資訊或活動非常有用，例如您的生日、婚禮或公司活動。

若要檢查演示，請使用密碼test 。

免責聲明：請注意，我（或依賴項）可能錯過了一些東西，所以不要認為這是萬無一失的。請勿以這種方式分享銀行資訊或類似資訊。

用法

• 透過點擊use this template按鈕從範本建立儲存庫
• 選擇儲存庫名稱（您的 URL 為{GITHUB-ACCOUNT-NAME}.github.io/{REPOSITORY-NAME} ）
• 如果您不希望人們無需密碼即可存取內容，請選擇將儲存庫設為私有
• 建立一個名為DECRYPTION_PASSPHRASE的 Github 金鑰，並將該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處於活動狀態。請注意，這只會將 HTML 文件中所有直接連結的圖像、CSS 和 JavaScript 文件替換為就地 base64 表示形式。因此，文件中的相對連結可能不再起作用，因為它們的位置發生了變化。

如果您不想加密資產

• 從_config.yml的exclude中刪除 asset 資料夾，
• 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 許可證
• 我們使用 Bootstrap，包括他們的範例之一（演示）：MIT License
• 我們使用六四的程式碼來確定圖像 MIME 類型：MIT 許可證
• 我們使用 Github CSS Ribbon：MIT 許可證