Cách dùng Trình tạo .env.example
- Dán nội dung
.envcủa bạn (dữ liệu không rời khỏi trình duyệt), hoặc chuyển sang Từ mã nguồn và dán code. - Các bí mật như khóa, token, mật khẩu và chuỗi kết nối sẽ bị xóa; giá trị an toàn như
PORT=3000được giữ nguyên. - Xem phần tóm tắt những gì đã bị xóa, giữ lại và được đánh dấu.
- Sao chép hoặc tải về
.env.examplerồi commit lên Git.
Vì sao nên commit file .env.example?
File .env chứa bí mật và tuyệt đối không được commit. Tuy nhiên, thành viên mới trong nhóm, CI và các nền tảng triển khai vẫn cần biết có những biến nào. File .env.example (còn gọi là .env.sample hoặc .env.template) liệt kê mọi khóa với giá trị giữ chỗ và chú thích, nên ai cũng có thể sao chép thành .env và điền giá trị của riêng mình.
Cách phát hiện bí mật
- Tên khóa chứa SECRET, TOKEN, PASSWORD, PASS, PWD, KEY, PRIVATE, CREDENTIAL, AUTH, SALT, DSN hoặc WEBHOOK.
- Mẫu giá trị như khóa Stripe (
sk_live_…), GitHub (ghp_…), AWS (AKIA…), Slack, OpenAI và Anthropic, JWT, khóa riêng PEM và URL có chứa mật khẩu (postgres://user:pass@…). - Chuỗi entropy cao — các giá trị dài trông ngẫu nhiên được coi là bí mật, kể cả khi tên khóa có vẻ vô hại.
Các giá trị mặc định an toàn (cổng, mức log, NODE_ENV, boolean, URL localhost) được giữ lại để ví dụ chạy được ngay. Kiểm tra file đã hoàn thiện bằng công cụ kiểm tra file .env, và giữ .env ngoài Git bằng trình tạo .gitignore.
Cũng được tìm dưới tên: tạo env example, env example generator, file .env.example, tạo file env mẫu, dotenv example, xóa secret khỏi file env, tìm biến môi trường trong code.
Các công cụ dùng kèm tốt với Trình tạo .env.example
- Tạo Dockerfile — Chọn stack của bạn và nhận ngay Dockerfile chuẩn production: multi-stage build, lớp cache cho dependency, người dùng non-root, health check và .dockerignore phù hợp, kèm giải thích từng dòng.
- Trình tạo Docker Compose — Chọn các dịch vụ bạn cần — ứng dụng, cơ sở dữ liệu, cache, giao diện quản trị, công cụ bắt mail — và nhận file compose.yaml gọn gàng với image đã ghim phiên bản, named volume, healthcheck và điều kiện depends_on, cùng file .env có sẵn mật khẩu được tạo ngẫu nhiên.
- Kiểm tra GitHub Actions — Dán workflow từ .github/workflows và tìm lỗi trước khi CI báo: trigger không hợp lệ, thiếu runs-on, needs sai, biểu thức lỗi, action lỗi thời và nguy cơ script injection.
- Kiểm tra YAML — Dán file Docker Compose, manifest Kubernetes, workflow GitHub Actions hoặc bất kỳ YAML nào để xác định chính xác lỗi, phát hiện các lỗi thường gặp và nhận bản đã định dạng gọn gàng.
Câu hỏi thường gặp
File .env của tôi có được tải lên không?
Quét mã nguồn hỗ trợ những ngôn ngữ nào?
process.env.X, process.env["X"], import.meta.env.X, Deno.env.get), Python (os.environ, os.getenv), Go (os.Getenv), Ruby (ENV["X"]), PHP (getenv, $_ENV), Rust (env::var), Java (System.getenv), C# và các tham chiếu ${VAR} trong Docker Compose.Gợi ý kiểu dữ liệu là gì?
# number, # boolean hoặc # url, được suy ra từ giá trị gốc, để người điền file biết định dạng cần nhập.