password protected website template

Modelo para site criptografado de página única

Este repositório de modelos facilita a criação de uma página protegida por senha hospedada nas páginas do Github. Isto pode ser útil para informações ou eventos que não deveriam estar disponíveis para todos, por exemplo, para o seu aniversário, casamento ou evento corporativo.

Para verificar a demonstração use o test de senha.

Isenção de responsabilidade : esteja ciente de que eu (ou as dependências) podemos ter perdido alguma coisa, então não presuma que isso seja à prova de balas. Não compartilhe informações bancárias ou similares desta forma.

Uso

• Crie um repositório a partir de um modelo clicando no botão use this template
• Selecione um nome de repositório (seu URL será {GITHUB-ACCOUNT-NAME}.github.io/{REPOSITORY-NAME} )
• Escolha o repositório como privado , caso não queira que as pessoas possam acessar o conteúdo sem a senha
• Crie um segredo do Github chamado DECRYPTION_PASSPHRASE e defina o value para a senha desejada (observe que o pipeline de CI falhará na primeira tentativa devido à falta de senha)
• Defina a fonte de publicação como branch main para ativar a hospedagem com Github Pages

Para personalizar o site:

• Você pode personalizar a página de login

  • ajuste o encrypt_with_assets.yml, ou seja, a etapa "Criptografar índice" para definir o título, as instruções e o nome do botão

    - 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 obter detalhes e alterar o layout completo, consulte StatiCrypt

• Edite o main.html que será mostrado aos visitantes após a criptografia (a versão criptografada que está hospedada é index.html )

  • Os ativos podem ser usados ​​normalmente e não serão criptografados

Ativos criptografados

Por padrão, a criptografia de ativos está habilitada, pois o fluxo de trabalho encrypt_with_assets.yml está ativo. Observe que isso apenas substitui todas as imagens vinculadas diretamente, arquivos CSS e JavaScript no documento HTML por uma representação base64 no local. Assim, seus links relativos em arquivos provavelmente não funcionarão mais, pois sua localização mudou.

Se você não deseja criptografar ativos

• remova a pasta de ativos dos exclude s de _config.yml ,
• encrypt_with_assets.yml para encrypt_with_assets._yml e
• renomeie encrypt_without_assets._yml para encrypt_with_assets.yml

Uso local

Se você não quiser ter nenhum dos seus dados (mesmo) em um repositório privado, você também pode convertê-los localmente e só fazer upload do index.html depois. Para fazer isso, siga estas etapas:

• Construa a imagem

   docker build -t ppw .
  

• Execute a criptografia

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

• Ignorar alterações em main.html

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

  Opcionalmente, o mesmo é necessário para seus ativos.

Créditos

• A criptografia é feita por StatiCrypt: Licença MIT
• Usamos o fluxo de trabalho de staticrypt-github-actions como base: Licença MIT
• Usamos Bootstrap, incluindo um de seus exemplos (demo): Licença MIT
• Usamos o código seis-quatro para determinar os tipos MIME de imagem: Licença MIT
• Usamos o Github CSS Ribbon: Licença MIT