password protected website template

Plantilla para sitio web cifrado de una sola página

Este repositorio de plantillas facilita la creación de una página protegida con contraseña alojada en páginas de Github. Esto puede resultar útil para información o eventos que no deberían estar disponibles para todos, por ejemplo, para su cumpleaños, boda o un evento corporativo.

Para comprobar la demostración utilice la test de contraseña.

Descargo de responsabilidad : tenga en cuenta que es posible que yo (o las dependencias) nos hayamos perdido algo, así que no asuma que esto es infalible. No compartas información bancaria o similar de esta manera.

Uso

• Cree un repositorio a partir de una plantilla haciendo clic en el botón use this template
• Seleccione un nombre de repositorio (su URL será {GITHUB-ACCOUNT-NAME}.github.io/{REPOSITORY-NAME} )
• Elija que el repositorio sea privado si no desea que las personas puedan acceder a los contenidos sin la contraseña.
• Cree un secreto de Github llamado DECRYPTION_PASSPHRASE y establezca el value en la contraseña deseada (tenga en cuenta que la canalización de CI fallará en el primer intento debido a que falta la contraseña).
• Configure la fuente de publicación en la rama main para activar el alojamiento con Github Pages

Para personalizar el sitio web:

• Puedes personalizar la página de inicio de sesión.

  • ajuste encrypt_with_assets.yml, es decir, el paso "Cifrar índice" para configurar el título, las instrucciones y el nombre del botón.

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

  • Para obtener más detalles y cambiar el diseño completo, consulte StatiCrypt

• Edite el main.html que se mostrará a los visitantes después del cifrado (la versión cifrada alojada es index.html ).

  • Los activos se pueden utilizar como de costumbre y no se cifrarán.

Activos cifrados

De forma predeterminada, el cifrado de activos está habilitado, ya que el flujo de trabajo encrypt_with_assets.yml está activo. Tenga en cuenta que esto solo reemplaza todas las imágenes directamente vinculadas, archivos CSS y JavaScript en el documento HTML con una representación base64 local. Por lo tanto, sus enlaces relativos en archivos probablemente ya no funcionarán, ya que su ubicación cambió.

Si no desea cifrar activos

• elimine la carpeta de activos de las exclude de _config.yml ,
• encrypt_with_assets.yml a encrypt_with_assets._yml y
• cambie el nombre encrypt_without_assets._yml a encrypt_with_assets.yml

Uso local

Si no desea tener ninguno de sus datos (ni siquiera) en un repositorio privado, también puede convertirlos localmente y solo cargar el index.html después. Para hacer esto, siga estos pasos:

• construir la imagen

   docker build -t ppw .
  

• Ejecute el cifrado

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

• Ignorar cambios en main.html

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

  Opcionalmente se necesita lo mismo para sus activos.

Créditos

• El cifrado se realiza mediante StatiCrypt: Licencia MIT
• Usamos el flujo de trabajo de staticrypt-github-actions como base: Licencia MIT
• Usamos Bootstrap, incluido uno de sus ejemplos (demo): Licencia MIT
• Usamos código de seis a cuatro para determinar los tipos MIME de imágenes: Licencia MIT
• Usamos la cinta CSS de Github: Licencia MIT