From 2de3efea15b37ab2501103688b1d73e0483fa5d1 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Mon, 3 Apr 2023 09:38:17 -0500 Subject: [PATCH] Update CF_API_KEY example for docker run (#2060) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index afeebc27..98f4801b 100644 --- a/README.md +++ b/README.md @@ -626,10 +626,10 @@ To manage a CurseForge modpack automatically with upgrade support, pinned or lat > environment: > CF_API_KEY: '$$11$$22$$33aaaaaaaaaaaaaaaaaaaaaaaaaa' > ``` -> If you use `docker run` you will need to escape the `$` with a `\`. -> Example: +> If you use `docker run` you will need to make sure to use single quotes: +> > ```shell -> docker run ... -e "CF_API_KEY=\$11\$22\$33aaaaaaaaaaaaaaaaaaaaaaaaaa" +> docker run ... -e CF_API_KEY='$11$22$33aaaaaaaaaaaaaaaaaaaaaaaaaa' > ``` > > To avoid exposing the API key, it is highly recommended to use a `.env` file, which is [loaded automatically by docker compose](https://docs.docker.com/compose/environment-variables/set-environment-variables/#substitute-with-an-env-file). `$`'s in the value still need to escaped with a second `$` and the variable needs to be referenced from the compose file, such as: