From 7e191dc26747f6002c187aea74130c907a5cdd71 Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Mon, 30 Jan 2023 16:59:10 +0100 Subject: [PATCH] Document use of .env --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 38bd277b..a65ee4ee 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,15 @@ Kubernetes is a beast. Running it yourself on your own hardware is not for the f ## Configuration +### Using .env to load required environment variables + +MRSK uses [dotenv](https://github.com/bkeepers/dotenv) to automatically load environment variables set in the `.env` file present in the application root. This file can be used to set variables like `MRSK_REGISTRY_PASSWORD` or database passwords. But for this reason you must ensure that .env files are not checked into Git or included in your Dockerfile! The format is just key-value like: + +```bash +MRSK_REGISTRY_PASSWORD=pw +DB_PASSWORD=secret123 +``` + ### Using another registry than Docker Hub The default registry is Docker Hub, but you can change it using `registry/server`: