问题:在 Docker 容器内安装 node_modules 并与主机同步

我在 Docker 容器内安装node_modules并将它们与主机同步时遇到问题。我的 Docker 版本是18.03.1-ce, build 9ee9f40,Docker Compose 的版本是 1.21.2, build a133471。

我的docker-compose.yml看起来像:

# Frontend Container.
frontend:
  build: ./app/frontend
  volumes:
    - ./app/frontend:/usr/src/app
    - frontend-node-modules:/usr/src/app/node_modules
  ports:
    - 3000:3000
  environment:
    NODE_ENV: ${ENV}
  command: npm start

# Define all the external volumes.
volumes:
  frontend-node-modules: ~

我的Dockerfile:

# Set the base image.
FROM node:10

# Create and define the working directory.
RUN mkdir /usr/src/app
WORKDIR /usr/src/app

# Install the application's dependencies.
COPY package.json ./
COPY package-lock.json ./
RUN npm install

许多博客文章和 Stack Overflow 的答案都描述了外部卷的技巧。比如这个。

该应用程序运行良好。源代码是同步的。热重载也很好用。

我唯一的问题是主机上的node_modules文件夹是空的。是否可以将 Docker 容器内的node_modules文件夹与主机同步?

我已经阅读了这些答案:

1.docker-compose volume on node_modules 但为空

2.Docker内npm install后访问node_modules

不幸的是,他们对我帮助不大。我不喜欢第一个,因为我不想在我的主机上运行npm install因为可能存在跨平台问题(例如主机是 Windows 或 Mac,Docker 容器是 Debian 8 或 Ubuntu 16.04 )。第二个对我也不好,因为我想在我的Dockerfile中运行npm install而不是在 Docker 容器启动后运行它。

另外,我发现这篇博文。作者试图解决我面临的同样问题。问题是node_modules不会同步,因为我们只是将它们从 Docker 容器复制到主机。

我希望 Docker 容器内的node_modules与主机同步。请考虑到我想要的:

• 自动安装node_modules而不是手动安装

• 将node_modules安装在 Docker 容器而不是主机中

• 让node_modules与主机同步(如果我在 Docker 容器内安装了一些新包,它应该自动与主机同步,无需任何手动操作)

我需要在主机上安装node_modules,因为:

• 可以在我需要时阅读源代码

• IDE 需要在本地安装node_modules,以便它可以访问devDependencies,例如eslint或prettier。我不想全局安装这些devDependencies。

提前致谢。

解答

首先,我要感谢David Maze和trust512发布他们的答案。不幸的是,他们没有帮助我解决我的问题。

我想发表我对这个问题的回答。

我的docker-compose.yml:

---
# Define Docker Compose version.
version: "3"

# Define all the containers.
services:
  # Frontend Container.
  frontend:
    build: ./app/frontend
    volumes:
      - ./app/frontend:/usr/src/app
    ports:
     - 3000:3000
    environment:
      NODE_ENV: development
    command: /usr/src/app/entrypoint.sh

我的Dockerfile:

# Set the base image.
FROM node:10

# Create and define the node_modules's cache directory.
RUN mkdir /usr/src/cache
WORKDIR /usr/src/cache

# Install the application's dependencies into the node_modules's cache directory.
COPY package.json ./
COPY package-lock.json ./
RUN npm install

# Create and define the application's working directory.
RUN mkdir /usr/src/app
WORKDIR /usr/src/app

最后但并非最不重要的entrypoint.sh:

#!/bin/bash

cp -r /usr/src/cache/node_modules/. /usr/src/app/node_modules/
exec npm start

这里最棘手的部分是将node_modules安装到我们的Dockerfile中定义的node_module的缓存目录(/usr/src/cache)中。之后,entrypoint.sh会将node_modules从缓存目录(/usr/src/cache)移动到我们的应用程序目录(/usr/src/app)。由于这一点,整个node_modules目录将出现在我们的主机上。

看看我上面的问题,我想要:

• 自动安装node_modules而不是手动安装

• 将node_modules安装在 Docker 容器而不是主机中

• 让node_modules与主机同步(如果我在Docker容器内安装了一些新包,它应该自动与主机同步,无需任何手动操作

第一件事是:自动安装node_modules。第二件事也完成了:node_modules安装在 Docker 容器内(因此,不会有跨平台问题)。第三件事也完成了:安装在 Docker 容器中的node_modules将在我们的主机上可见,并且它们将被同步!如果我们在 Docker 容器中安装一些新包,它将立即与我们的主机同步。

需要注意的重要一点:说真的,安装在 Docker 容器中的新包,会出现在/usr/src/app/node_modules中。由于这个目录与我们的主机同步,这个新包也会出现在我们主机的node_modules目录中。但是此时/usr/src/cache/node_modules将具有旧版本(没有这个新包)。无论如何,这对我们来说不是问题。在下一个docker-compose up --build(需要--build)期间,Docker 将重新安装node_modules(因为package.json已更改)并且entrypoint.sh文件会将它们移动到我们的/usr/src/app/node_modules。

你应该考虑一件更重要的事情。如果你是git pull来自远程仓库的代码或者是在Docker运行时的git checkout your-teammate-branch,可能会有一些新的包被添加到package.json文件中。在这种情况下,您应该使用CTRL + C停止 Docker,然后使用docker-compose up --build再次启动它(需要--build)。如果您的容器作为守护进程运行,您应该只执行docker-compose stop来停止容器并使用docker-compose up --build再次启动它(需要--build)。

如果您有任何问题,请在评论中告诉我。

希望这可以帮助。