From dde2705114a2f27816bf1f30a99296370a882133 Mon Sep 17 00:00:00 2001 From: Ryan Conrad Date: Thu, 30 Mar 2023 15:32:49 -0500 Subject: [PATCH 1/2] added docs to use env file --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index b2e1b45a720..df7ef9daa92 100644 --- a/README.md +++ b/README.md @@ -631,6 +631,23 @@ To manage a CurseForge modpack automatically with upgrade support, pinned or lat > ```shell > docker run ... -e "CF_API_KEY=\$11\$22\$33aaaaaaaaaaaaaaaaaaaaaaaaaa" > ``` +> You can also use an [environemnt file](https://docs.docker.com/compose/environment-variables/set-environment-variables/) to load your confguration values. Using an environment file will remove the need to escape your API Key. +> +> ``` +> TYPE=AUTO_CURSEFORGE +> CF_API_KEY=$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa +> ``` +> +> Configure docker-compose +> ```yaml +> minecraft: +> env_file: +> - ./minecraft-server.env +> ``` +> Configure `docker run` +> ``` +> docker run ... --env-file=./minecraft-server.env +> ``` > > Be sure to use the appropriate [image tag for the Java version compatible with the modpack](#running-minecraft-server-on-different-java-version). > From eab1c3a347d3ee222c953c214fa48a0da7872138 Mon Sep 17 00:00:00 2001 From: Ryan Conrad Date: Thu, 30 Mar 2023 17:21:12 -0500 Subject: [PATCH 2/2] update docs with .env info --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index df7ef9daa92..5b381e67edd 100644 --- a/README.md +++ b/README.md @@ -631,22 +631,16 @@ To manage a CurseForge modpack automatically with upgrade support, pinned or lat > ```shell > docker run ... -e "CF_API_KEY=\$11\$22\$33aaaaaaaaaaaaaaaaaaaaaaaaaa" > ``` -> You can also use an [environemnt file](https://docs.docker.com/compose/environment-variables/set-environment-variables/) to load your confguration values. Using an environment file will remove the need to escape your API Key. -> +> You can use a `.env` file, in the same directory as your `docker-compose.yaml`, and define your API Key there to remove the need to escape the `$` in your API Key. The `.env` file is [loaded automatically by docker compose](https://docs.docker.com/compose/environment-variables/set-environment-variables/#substitute-with-an-env-file). +> +> *.env* > ``` -> TYPE=AUTO_CURSEFORGE > CF_API_KEY=$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa > ``` > -> Configure docker-compose -> ```yaml -> minecraft: -> env_file: -> - ./minecraft-server.env -> ``` -> Configure `docker run` +> To use with `docker run` you need to specify the `.env` file > ``` -> docker run ... --env-file=./minecraft-server.env +> docker run --env-file=.env itzg/minecraft-server > ``` > > Be sure to use the appropriate [image tag for the Java version compatible with the modpack](#running-minecraft-server-on-different-java-version).