nodejs / nodejs/docker-node

Broken NPM cache folder settings do not allow running image without root

Đang mở
#2,495 4 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

permissions
Ngôn ngữ chính
Dockerfile
Star
8.6k
Fork
2k
Merge trung bình
10 giờ 19 phút
Pull request đã merge (30 ngày)
16

Mô tả

Environment

  • Platform: Linux
  • Docker Version: Docker Engine v29 (but can be replicated with older versions)
  • Node.js Version: LTS 24 and 22 (can be replicated with all versions from v16)
  • Image Tag: 22.22.2-alpine

Expected Behavior

Unmodified Node.js Docker image should be runnable without root privileges.

Current Behavior

The image is completely broken as a base build image in environments where one could not modify a running user, e.g., on Jenkins pipelines which by default run under Jenkins user and the UID is most probably not the same as UID 1000 which is used in the image. The same issue can be observed on the free GitHub Actions runners.

It is also broken as a base runtime image on read-only root filesystem environments, e.g., Kubernetes containers with readOnlyRootFilesystem: true.

The source of these issues is that npm_config_prefix is set to /usr/local and npm_config_userconfig is not set at all, so NPM is trying to use HOME folder which in the docker image is set to /. That folder is not writable by any of the users except root.

The only workaround on Jenkins is to set NPM_CONFIG_CACHE to something like /tmp/jenkins/.npm. GitLab/GitHub runners can be fixed in similar manner.

Possible Solution

The real fix should be to create .npm cache folder somewhere writable by any user on the docker image, so at least it works by default on CI pipelines. Maybe create some kind of documented folder specified via npm_config_userconfig so anyone can map it and modify the behaviour of a running user.

Steps to Reproduce

Create a Jenkins pipeline for any Node.js project using NPM and try to build it:

pipeline {
  agent {
    docker {
      image 'node:22.22.2'
    }
  }
  stages {
    stage('Build and publish') {
      steps {
        sh "npm ci"
        sh "npm run build"
        sh "npm publish"
      }
    }
  }
}
12:51:45  npm error code EACCES
12:51:45  npm error syscall mkdir
12:51:45  npm error path /.npm
12:51:45  npm error errno EACCES
12:51:45  npm error
12:51:45  npm error Your cache folder contains root-owned files, due to a bug in
12:51:45  npm error previous versions of npm which has since been addressed.
12:51:45  npm error
12:51:45  npm error To permanently fix this problem, please run:
12:51:45  npm error   sudo chown -R 1002:1002 "/.npm"

Additional Information

I chose Jenkins as an example. The same issue can be reproduced in any CI/CD environment which doesn't run under root user: rootless Docker, GitHub Actions, etc.

As evident from the past, considering cryptic and sometimes incorrect error messages coming from NPM, people constantly struggle to understand why it doesn't work for them in one way or another:
https://github.com/nodejs/docker-node/issues/1734
https://github.com/npm/cli/issues/3910

I know that there are some practices documented how to run this image without a root user, but that's not the point of this ticket. It can be fixed at the source of this image without the need to use all those workarounds.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách kiểm tra cấu hình Docker image để tìm npm_config_prefix, npm_config_userconfig, HOME và các vị trí cache có thể ghi. Tái hiện Jenkins pipeline được báo cáo với tư cách người dùng không phải root và với filesystem gốc chỉ đọc. Được coi là hoàn tất khi npm ci, npm run build và npm publish hoạt động mà không yêu cầu root hoặc ghi đè cache cho từng lần chạy.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
docker, node.js
Lĩnh vực
devops, infrastructure
Loại issue
Lỗi
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
48/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.