Zum Inhalt springen
snowkitDev

Eine .env.example erstellen, ohne Geheimnisse preiszugeben

Füge eine .env-Datei ein oder öffne sie und erhalte eine .env.example mit jedem entfernten Wert, erhaltenen Kommentaren und Gruppierung und mit angezeigten Problemen wie doppelten Schlüsseln.

.env zu .env.example

Füge eine .env-Datei ein oder öffne sie. Werte werden beim Tippen entfernt.

.env.example


            

Variablen

    Optionen

    Harmlose Werte sind kurze Zahlen, true oder false, Umgebungsnamen wie production und localhost-Adressen. Alles, dessen Name ein Geheimnis nahelegt, wird immer entfernt.

    Mit einer vorhandenen .env.example vergleichen

      Als env.example gespeichert. Benenne sie in deinem Projekt in .env.example um.

      Deine .env-Datei wird nur in diesem Tab gelesen. Sie wird nie hochgeladen und nie gespeichert. Mach aus einer echten .env-Datei eine sichere .env.example, die du committen kannst, mit entfernten Werten und erhaltenen Kommentaren. Kostenlos und in deinem Browser.

      So erstellst du eine .env.example

      1. Füge deine Datei in das .env-Feld ein oder klicke auf „.env-Datei öffnen“. „Beispiel ausprobieren“ lädt ein Beispiel.
      2. Wähle, wodurch Werte ersetzt werden: Nichts (KEY=), Ein Hinweis (KEY=your_key) oder Leere Anführungszeichen (KEY="").
      3. Wähle, was erhalten bleibt: „Kommentarzeilen behalten“, „Kommentare nach Werten behalten“, „Leerzeilen zwischen Gruppen behalten“ und „Harmlose Werte wie PORT=3000 behalten“.
      4. Füge optional deine aktuelle Datei unter „Vorhandene .env.example“ ein, um zu vergleichen.
      5. Klicke auf „Kopieren“ oder „.env.example herunterladen“.

      Warum eine .env.example behalten

      Eine .env-Datei enthält die Einstellungen und Geheimnisse, die eine App braucht, und sie sollte nie committet werden. Eine .env.example listet dieselben Schlüssel mit entfernten Werten auf, damit jeder, der das Projekt einrichtet, weiß, was auszufüllen ist. Die Kommentare aus deiner eigenen Datei zu behalten erklärt, wofür jeder Wert gedacht ist.

      Was erhalten bleibt und was entfernt wird

      Jeder Wert wird standardmäßig entfernt, auch Werte in Anführungszeichen und mehrzeilige Werte wie private Schlüssel. Kommentarzeilen, Kommentare nach Werten, export-Präfixe und die Leerzeilen, die Einstellungen gruppieren, bleiben genau so erhalten, wie du sie geschrieben hast; nichts wird hinzugefügt. Zeilen, die nicht KEY=Wert sind, und wiederholte Schlüssel werden weggelassen und aufgelistet, damit du das Original korrigieren kannst.

      Tipps

      • Füge über jedem Schlüssel einen kurzen Kommentar hinzu, der erklärt, woher der Wert stammt.
      • Gruppiere zusammengehörige Schlüssel mit Leerzeilen, etwa Datenbank, E-Mail und Zahlungen.
      • Stelle sicher, dass die echte .env in deiner .gitignore steht. Der .gitignore-Generator kann eine schreiben.
      • Aktualisiere das Beispiel, wann immer du eine Einstellung hinzufügst, damit neue Teammitglieder nicht raten müssen.
      • Wenn ein Geheimnis je committet wurde, ändere es. Das spätere Entfernen der Zeile entfernt es nicht aus der Historie.

      Für wen

      Entwickler, Studierende, die ein Projekt teilen, und Freiberufler, die eine Codebasis an einen Kunden übergeben, alle, die Einrichtungsanweisungen ohne preisgegebene Passwörter und Schlüssel wollen.

      Fragen

      Kann ich hier bedenkenlos echte Secrets einfügen?

      Die Seite arbeitet komplett auf deinem Gerät und kann das Eingefügte nirgendwohin senden. Geh trotzdem sorgsam mit Secrets um: Schließ den Tab, wenn du fertig bist.

      Kann ich einige Werte behalten?

      Aktiviere „Harmlose Werte behalten“, um Einträge wie PORT=3000, DEBUG=false oder NODE_ENV=development zu behalten. Werte, deren Schlüssel auf secret, token, password oder key hinweist, Werte mit einem Passwort in einer URL und lange, zufällig wirkende Zeichenketten werden weiterhin entfernt.

      Warum heißt der Download env.example?

      Browser speichern keine Dateien, deren Name mit einem Punkt beginnt, daher heißt der Download env.example. Benenne ihn in .env.example um, wenn du ihn deinem Projekt hinzufügst, oder kopiere den Inhalt und füge ihn in eine neue Datei ein.

      Wie prüfe ich, ob eine alte .env.example aktuell ist?

      Öffne „Mit vorhandener .env.example vergleichen“ und füge sie ein. Aufgelistet werden Schlüssel aus deiner .env, die im Beispiel fehlen, und Schlüssel im Beispiel, die deine .env nicht hat.

      Wie geht’s weiter

      Mach mit deinem Ergebnis weiter, weiterhin auf deinem Gerät.

      Mehr von Snowkit