How to pass environment variable to docker-compose up

Question

I am trying to run a container. I already have the image uploaded to private Docker registry. I want to write a compose file to download and deploy the image. But I want to pass the TAG name as a variable from the docker-compose run command.My compose file looks like below. How can I pass the value for KB_DB_TAG_VERSION as part of docker-compose up command?

version: '3'
services:
   db:
    #build: k-db
    user: "1000:50"
    volumes:
      - /data/mysql:/var/lib/mysql
    container_name: k-db
    environment:
      - MYSQL_ALLOW_EMPTY_PASSWORD=yes
    image:  XX:$KB_DB_TAG_VERSION
    image: k-db
    ports:
      - "3307:3306"

Answer 1

You have two options (option 2. overrides 1.):

1. Create the .env file as already suggested in another answer.

2. Prepend KEY=VALUE pair(s) to your docker-compose command, e.g:

   KB_DB_TAG_VERSION=kb-1.3.20-v1.0.0 docker-compose up
   

   Exporting it earlier in a script should also work, e.g.:

   export KB_DB_TAG_VERSION=kb-1.3.20-v1.0.0
   docker-compose up
   

Keep in mind that these options just pass an environment varible to the docker-compose.yml file, not to a container. For an environment variable to be actually passed to a container you always need something like this in your docker-compose.yml:

  environment:
    - KB_DB_TAG_VERSION=$KB_DB_TAG_VERSION

Answer 2

You can create a .env file on the directory where you execute the docker-compose up command (and your docker-compose.yml file is located) with the following content:

KB_DB_TAG_VERSION=kb-1.3.20-v1.0.0

Your docker-compose.yml file should look like the following (added { and }):

version: '3'
services:
   db:
     user: "1000:50"
     volumes:
       - /data/mysql:/var/lib/mysql
     container_name: k-db
     environment:
       - MYSQL_ALLOW_EMPTY_PASSWORD=yes
     image: XX:${KB_DB_TAG_VERSION}
     image: k-db
     ports:
       - "3307:3306"

After making the above changes , check whether the changes are reflected or not using the command docker-compose config. The variable will be replaced by the variable value. Please refer to the page here to understand more about variable replacement.

Answer 3

Just to supplement what has been outlined by others, in particular by @JakubKukul

For security purposes you probably wouldn't want to keep vulnerable information such as username/password in your docker-compose files if they're under version control. You can map environment variables that you have on your host to environment variables inside container as well. In this case it could be something like the following:

version: '3'
services:
   db:
    #build: k-db
    user: "1000:50"
    volumes:
      - /data/mysql:/var/lib/mysql
    container_name: k-db
    environment:
      - MYSQL_ALLOW_EMPTY_PASSWORD=yes
      - MYSQL_PASSWORD=${MYSQL_PASSWORD}
    image:  XX:$KB_DB_TAG_VERSION
    image: k-db
    ports:
      - "3307:3306"

where MYSQL_PASSWORD would be both:

1. An environment variable on your host (maybe just in the current shell session)
2. An environment variable inside the containers from the db service

Answer 4

It's possible to pass environment variables to containers on the command line without specifying the values in files. Add an environment key with the variable's name only (no value or assignment operator) on the container's service definition in the docker-compose file:

db:
    ...
    environment:
        - KB_DB_TAG_VERSION

Used in that way, with no assignment, means that docker-compose will look up the environment variable in the current environment/shell:

KB_DB_TAG_VERSION=mytagversion docker-compose up

Ref: https://docs.docker.com/compose/environment-variables/#pass-environment-variables-to-containers

Answer 5

docker-compose  --env-file .\.env up

https://docs.docker.com/compose/environment-variables/

Answer 6

The doc that you can declare the env file in compose -

web:
  env_file:
    - web-variables.env

Answer 7

For Windows, instead of export, use:

$env.KB_DB_TAG_VERSION = "1.3.20-v1.0.0"
docker-compose up

Answer 8

In your docker-compose.yml file add

env_file:
  - .env_file

to your db service where .env_file is your .env file (change its name accordingly).

version: '3'
services:
   db:
    #build: k-db
    user: "1000:50"
    volumes:
      - /data/mysql:/var/lib/mysql
    container_name: k-db
    env_file:
      - .env_file
    environment:
      - MYSQL_ALLOW_EMPTY_PASSWORD=yes
    image:  XX:$KB_DB_TAG_VERSION
    image: k-db
    ports:
      - "3307:3306"