Votre fichier .env est lu dans cet onglet seulement. Il n'est jamais envoyé ni stocké. Transformez un vrai fichier .env en .env.example sûr que vous pouvez commiter, avec les valeurs retirées et les commentaires conservés. C'est gratuit et cela s'exécute dans votre navigateur.
Comment créer un .env.example
- Collez votre fichier dans la zone .env, ou appuyez sur Ouvrir un fichier .env. Essayer un exemple charge un échantillon.
- Choisissez par quoi Remplacer les valeurs : Rien (CLÉ=), Un indice (CLÉ=votre_clé) ou Guillemets vides (CLÉ="").
- Choisissez ce qu'il faut garder : Garder les lignes de commentaire, Garder les commentaires après les valeurs, Garder les lignes vides entre les groupes, et Garder les valeurs inoffensives comme PORT=3000.
- Si vous voulez, collez votre fichier actuel dans .env.example existant pour comparer.
- Appuyez sur Copier ou Télécharger le .env.example.
Pourquoi garder un .env.example
Un fichier .env contient les réglages et secrets dont une appli a besoin, et il ne doit jamais être commité. Un .env.example liste les mêmes clés sans les valeurs, pour que quiconque installe le projet sache quoi renseigner. Garder les commentaires de votre propre fichier explique à quoi sert chaque valeur.
Ce qui est conservé et ce qui est retiré
Chaque valeur est retirée par défaut, y compris les valeurs entre guillemets et sur plusieurs lignes comme les clés privées. Les lignes de commentaire, les commentaires après les valeurs, les préfixes export et les lignes vides qui regroupent les réglages sont conservés exactement comme vous les avez écrits ; rien n'est ajouté. Les lignes qui ne sont pas CLÉ=valeur et les clés répétées sont laissées de côté et listées pour que vous corrigiez l'original.
Conseils
- Ajoutez un court commentaire au-dessus de chaque clé pour dire où obtenir la valeur.
- Regroupez les clés liées avec des lignes vides, comme base de données, e-mail et paiements.
- Assurez-vous que le vrai .env figure dans votre .gitignore. Le générateur de .gitignore peut en écrire un.
- Mettez à jour l'exemple chaque fois que vous ajoutez un réglage, pour que les nouveaux coéquipiers ne soient pas laissés à deviner.
- Si un secret a un jour été commité, changez-le. Retirer la ligne plus tard ne l'enlève pas de l'historique.
Qui l'utilise
Développeurs, étudiants qui partagent un projet et freelances qui remettent une base de code à un client, toute personne qui veut des instructions d'installation sans exposer mots de passe et clés.
Questions
Est-il sûr de coller ici de vrais secrets ?
La page fonctionne entièrement sur votre appareil et n'a aucun moyen d'envoyer ce que vous collez ailleurs. Malgré tout, traitez les secrets avec soin : fermez l'onglet quand vous avez terminé.
Puis-je conserver certaines valeurs ?
Activez Garder les valeurs inoffensives pour conserver des éléments comme PORT=3000, DEBUG=false ou NODE_ENV=development. Les valeurs dont la clé mentionne un secret, un jeton, un mot de passe ou une clé, les valeurs avec un mot de passe dans une URL et les longues chaînes d'apparence aléatoire sont toujours retirées.
Pourquoi le téléchargement s'appelle-t-il env.example ?
Les navigateurs n'enregistrent pas les fichiers dont le nom commence par un point : le téléchargement s'appelle donc env.example. Renommez-le en .env.example quand vous l'ajoutez à votre projet, ou utilisez Copier et collez dans un nouveau fichier.
Comment vérifier qu'un ancien .env.example est à jour ?
Ouvrez Comparer avec un .env.example existant et collez-le. Les clés de votre .env absentes de l'exemple, et les clés de l'exemple absentes de votre .env, sont listées.