How do I mount a host directory as a volume in docker compose

Question

I have a development environment I'm dockerizing and I would like the ability to livereload my changes without having to rebuild docker images. I'm using docker compose because redis is one of my app's dependencies and I like being able to link a redis container

I have two containers defined in my docker-compose.yml:

node:
  build: ./node
  links:
    - redis
  ports:
    - "8080"
  env_file:
    - node-app.env

redis:
  image: redis
  ports:
    - "6379"

I've gotten to the point in my node app's dockerfile where I add a volume, but how do I mount the the host's directory in the volume so that all my live edits to the code are reflected in the container?

Here's my current Dockerfile:

# Set the base image to Ubuntu
FROM    node:boron

# File Author / Maintainer
MAINTAINER Amin Shah Gilani <amin@gilani.me>

# Install nodemon
RUN npm install -g nodemon

# Add a /app volume
VOLUME ["/app"]

# TODO: link the current . to /app

# Define working directory
WORKDIR /app

# Run npm install
RUN npm install

# Expose port
EXPOSE  8080

# Run app using nodemon
CMD ["nodemon", "/app/app.js"]

My project looks like this:

/
- docker-compose.yml
- node-app.env
- node/
  - app.js
  - Dockerfile.js

jkris · Accepted Answer · 2021-02-04T02:04:56.440

198

~~Checkout their documentation~~

From the looks of it you could do the following on your docker-compose.yml

volumes:
    - ./:/app

Where ./ is the host directory, and /app is the target directory for the containers.

EDIT:
Previous documentation source now leads to version history, you'll have to select the version of compose you're using and look for the reference.

For the lazy – v3 / v2 / v1

Side note: Syntax remains the same for all versions as of this edit

edited Feb 04 '21 at 02:04

answered Dec 01 '16 at 08:30

jkris

3,913
1
19
29

2

Tried it, it didn't work: `Error: Cannot find module '/data/app.js'` – Amin Shah Gilani Dec 01 '16 at 08:33
3

wait.. your VOLUME and WORKDIR points to `/app/` why is your CMD pointing to `/data` – jkris Dec 01 '16 at 08:35
1

That was an error! Thank you for catching that! Fixed, and now I get `Error: Cannot find module 'express'` I'm gonna try a few things now. – Amin Shah Gilani Dec 01 '16 at 08:37
7

For windows containers, you'll want a windows style path like `- .:c:/app` (this tripped me up) – JohnnyFun Feb 12 '20 at 01:25
I have lots of stuff in my current directory but the volume directory has nothing in it. volumes: - .:/stocks – rjurney Aug 31 '20 at 21:32
There's no mention of `volume` in https://docs.docker.com/compose/compose-file/#volumes – AlikElzin-kilaka Feb 02 '21 at 12:45

score 124 · Answer 2 · edited Oct 27 '20 at 16:27

There are a few options

Short Syntax

Using the host : guest format you can do any of the following:

volumes:
  # Just specify a path and let the Engine create a volume
  - /var/lib/mysql

  # Specify an absolute path mapping
  - /opt/data:/var/lib/mysql

  # Path on the host, relative to the Compose file
  - ./cache:/tmp/cache

  # User-relative path
  - ~/configs:/etc/configs/:ro

  # Named volume
  - datavolume:/var/lib/mysql

Long Syntax

As of docker-compose v3.2 you can use long syntax which allows the configuration of additional fields that can be expressed in the short form such as mount type (volume, bind or tmpfs) and read_only.

version: "3.2"
services:
  web:
    image: nginx:alpine
    ports:
      - "80:80"
    volumes:
      - type: volume
        source: mydata
        target: /data
        volume:
          nocopy: true
      - type: bind
        source: ./static
        target: /opt/app/static

networks:
  webnet:

volumes:
  mydata:

Check out https://docs.docker.com/compose/compose-file/#long-syntax-3 for more info.

score 44 · Answer 3 · edited Oct 27 '20 at 16:28

44

If you would like to mount a particular host directory (/disk1/prometheus-data in the following example) as a volume in the volumes section of the Docker Compose YAML file, you can do it as below, e.g.:

version: '3'

services:
  prometheus:
    image: prom/prometheus
    volumes:
      - prometheus-data:/prometheus

volumes:
  prometheus-data:
    driver: local
    driver_opts:
      o: bind
      type: none
      device: /disk1/prometheus-data

By the way, in prometheus's Dockerfile, You may find the VOLUME instruction as below, which marks it as holding externally mounted volumes from native host, etc. (Note however: this instruction is not a must though to mount a volume into a container.):

Dockerfile

...
VOLUME ["/prometheus"]
...

Refs:

edited Oct 27 '20 at 16:28

Bonifacio2

2,687
4
30
44

answered May 02 '19 at 12:11

Yuci

17,258
5
80
93

This worked. Thanks. Where is the documentation for the `local` driver type? – mmell Aug 01 '19 at 12:44
@mmell The documentation is the first Refs link (https://docs.docker.com/compose/compose-file/#driver) It reads: Specify which volume driver should be used for this volume. Defaults to whatever driver the Docker Engine has been configured to use, which in most cases is `local` – Yuci Aug 01 '19 at 13:15
1

@mmell, you can find more details from this question: https://stackoverflow.com/questions/42195334/docker-compose-volumes-driver-local-meaning – Yuci Aug 01 '19 at 13:26
How did you know the settings in ```driver_opts: o: bind type: none```? – mmell Aug 02 '19 at 11:27
1

@mmell Basically, those options are driver-dependent, and the built-in `local` driver on Linux accepts options similar to the linux mount command: http://man7.org/linux/man-pages/man8/mount.8.html. You can find more discussion at https://github.com/moby/moby/issues/19990#issuecomment-248955005, and https://stackoverflow.com/questions/35841241/docker-compose-named-mounted-volume – Yuci Aug 02 '19 at 13:31
@JackNavaRow, check this out: https://stackoverflow.com/questions/41212086/error-docker-compose-docker-windows/41216551#41216551 – Yuci Oct 02 '19 at 22:37
@Yuci it works in window, i added a litle configuration , I hope that you accept it, thanks bro! – JackNavaRow Oct 03 '19 at 12:28
This answer should be the accepted one for a separate question about how to mount a host directory across multiple containers; twas hard to find this! – jiminikiz Nov 08 '19 at 20:22

score 14 · Answer 4 · edited Oct 27 '20 at 16:29

It was two things:

I added the volume in docker-compose.yml:

node:
  volumes:
    - ./node:/app

I moved the npm install && nodemon app.js pieces into a CMD because RUN adds things to the Union File System, and my volume isn't part of UFS.

# Set the base image to Ubuntu
FROM    node:boron

# File Author / Maintainer
MAINTAINER Amin Shah Gilani <amin@gilani.me>

# Install nodemon
RUN npm install -g nodemon

# Add a /app volume
VOLUME ["/app"]

# Define working directory
WORKDIR /app

# Expose port
EXPOSE  8080

# Run npm install
CMD npm install && nodemon app.js

score 8 · Answer 5 · edited Oct 27 '20 at 16:31

we have to create your own docker volume mapped with the host directory before we mention in the docker-compose.yml as external

1.Create volume named share

docker volume create --driver local \
--opt type=none \
--opt device=/home/mukundhan/share \
--opt o=bind share

2.Use it in your docker-compose

version: "3"

volumes:
  share:
    external: true

services:
  workstation:
    container_name: "workstation"
    image: "ubuntu"
    stdin_open: true
    tty: true
    volumes:
      - share:/share:consistent
      - ./source:/source:consistent
    working_dir: /source
    ipc: host
    privileged: true
    shm_size: '2gb'
  db:
    container_name: "db"
    image: "ubuntu"
    stdin_open: true
    tty: true
    volumes:
      - share:/share:consistent
    working_dir: /source
    ipc: host

This way we can share the same directory with many services running in different containers

that is only needed when we need to bind the network into host itself. — Mukundhan, Jul 15 '20 at 10:32

score 0 · Answer 6 · answered Dec 16 '20 at 21:07

0

In docker-compose.yml you can use this format:

volumes:
    - host directory:container directory

according to their documentation

answered Dec 16 '20 at 21:07

Good man

147
1
9

How do I mount a host directory as a volume in docker compose

6 Answers6

Short Syntax

Long Syntax

Linked

Related