Ir para o conteúdo
snowkitDev

Crie um .env.example sem vazar segredos

Cole ou abra um arquivo .env e obtenha um .env.example com todos os valores removidos, os seus comentários e o agrupamento mantidos e problemas como chaves duplicadas apontados.

.env para .env.example

Cole ou abra um arquivo .env. Os valores são removidos enquanto você digita.

.env.example


            

Variáveis

    Options

    Valores inofensivos são números curtos, verdadeiro ou falso, nomes de ambiente como production e endereços localhost. Tudo cujo nome sugere um segredo é sempre removido.

    Comparar com um .env.example existente

      Salvo como env.example. Renomeie para .env.example no seu projeto.

      Seu arquivo .env é lido só nesta aba. Nunca é enviado nem guardado. Transforme um arquivo .env de verdade em um .env.example seguro que você pode commitar, com os valores removidos e os comentários mantidos. É grátis e roda no seu navegador.

      Como criar um .env.example

      1. Cole o arquivo na caixa .env ou toque em Abrir um arquivo .env. Experimente um exemplo carrega uma amostra.
      2. Escolha com o que Substituir os valores: Nada (KEY=), Uma dica (KEY=your_key) ou Aspas vazias (KEY="").
      3. Escolha o que manter: Manter linhas de comentário, Manter comentários depois dos valores, Manter linhas em branco entre os grupos e Manter valores inofensivos como PORT=3000.
      4. Se quiser, cole o arquivo atual em .env.example existente para comparar.
      5. Toque em Copiar ou Baixar .env.example.

      Por que manter um .env.example

      Um arquivo .env guarda as configurações e segredos de que um app precisa e nunca deve ser commitado. Um .env.example lista as mesmas chaves com os valores removidos, para quem configura o projeto saber o que preencher. Manter os comentários do seu próprio arquivo explica para que serve cada valor.

      O que é mantido e o que é removido

      Todo valor é removido por padrão, incluindo valores entre aspas e de várias linhas como chaves privadas. Linhas de comentário, comentários depois de valores, prefixos export e as linhas em branco que agrupam configurações são mantidos exatamente como você escreveu; nada é adicionado. Linhas que não são KEY=valor e chaves repetidas ficam de fora e são listadas para você corrigir o original.

      Dicas

      • Adicione um comentário curto acima de cada chave explicando onde obter o valor.
      • Agrupe chaves relacionadas com linhas em branco, como banco de dados, e-mail e pagamentos.
      • Garanta que o .env de verdade esteja listado no seu .gitignore. O gerador de .gitignore pode escrever um.
      • Atualize o exemplo sempre que adicionar uma configuração, para os novos colegas não ficarem no escuro.
      • Se um segredo já foi commitado, troque. Remover a linha depois não o remove do histórico.

      Quem usa

      Desenvolvedores, estudantes que compartilham um projeto e freelancers que entregam um código a um cliente, qualquer pessoa que quer instruções de configuração sem expor senhas e chaves.

      Perguntas

      É seguro colar segredos reais aqui?

      A página funciona inteiramente no seu dispositivo e não tem como enviar o que você cola para lugar nenhum. Mesmo assim, trate segredos com cuidado: feche a aba quando terminar.

      Posso manter alguns valores?

      Ative Manter valores inofensivos para manter coisas como PORT=3000, DEBUG=false ou NODE_ENV=development. Valores cuja chave menciona segredo, token, senha ou chave, valores com senha dentro de uma URL e textos longos com aparência aleatória continuam sendo removidos.

      Por que o download se chama env.example?

      Os navegadores não salvam arquivos cujo nome começa com ponto, então o download se chama env.example. Renomeie para .env.example ao adicioná-lo ao projeto, ou use Copiar e cole em um arquivo novo.

      Como confiro se um .env.example antigo está atualizado?

      Abra Comparar com um .env.example existente e cole-o. São listadas as chaves do seu .env que faltam no exemplo e as chaves do exemplo que o seu .env não tem.

      Para onde ir agora

      Continue com o que você acabou de criar, ainda no seu dispositivo.

      Mais do Snowkit