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 许可证