alpinelab/ruby-dev

alpinelab/ruby-dev https://img.shields.io/docker/stars/alpinelab/ruby-dev.svg?style=flat-square](https://hub.docker.com/r/alpinelab/ruby-dev/) https://img.shields.io/docker/pulls/alpinelab/ruby-dev.svg?style=flat-square](https://hub.docker.com/r/alpinelab/ruby-dev/)

该项目的主要目标是提供一个单一Docker镜像用于开发所有Ruby项目，所有依赖均包含在Docker内部（如gems、NPM包甚至Ruby本身，不会污染主机环境），且镜像中不包含任何项目特定内容（代码库从主机文件系统直接挂载到容器内，因此添加gem或修改代码时无需构建镜像）。

Docker容器还提供开发者友好的工具和行为，如持久化Ruby控制台历史（IRB和Pry）、shell历史，甚至自动安装依赖（只需修改Gemfile或package.json，bundle install或yarn install将自动运行，且仅在必要时执行）。它还提供少量CLI工具：vim、nano、heroku。

默认命令（执行docker-compose up时）是运行foreman start，启动Procfile中定义的服务。所有命令在容器内以代码库所有者（可能是主机用户）身份运行，因此容器内生成的文件（如rails generate、yarn init或日志文件）将归主机用户所有，而非root。

该镜像采用合理默认约定，同时支持配置（如Heroku CLI或Git认证）和自定义（在容器内安装额外软件）。更多详情见使用指南。

TL;DR 🙄

• 代码库双向挂载：主机目录挂载到容器内/app
• [***]
• Bundler配置为将gems存储在/bundle
• https://github.com/rubygems/rubygems%E9%85%8D%E7%BD%AE%E4%B8%BA%E5%B0%86%E7%9B%B4%E6%8E%A5%E5%AE%89%E8%A3%85%E7%9A%84gems%EF%BC%88%60gem install …）存储在/bundle/global`
• 容器内所有操作使用主机用户的UID和GID
• bundle install在命令执行前自动运行（仅必要时）
• yarn install在命令执行前自动运行（仅必要时）
• 可通过使用指南自定义镜像，安装额外软件

核心功能与特性

• 依赖隔离：所有Ruby gems、NPM包等依赖均包含在容器内，不污染主机环境
• 代码实时挂载：代码库从主机直接挂载到容器，修改代码或添加依赖无需构建镜像
• 自动依赖安装：修改Gemfile或package.json后，bundle install或yarn install自动运行（仅必要时）
• 持久化历史：保留Ruby控制台（IRB和Pry）及shell历史记录
• 用户权限一致：以主机代码库所有者身份运行命令，容器内生成文件归主机用户所有（非root）
• 默认服务启动：docker-compose up默认执行foreman start，启动Procfile中定义的服务
• 基础开发工具：内置vim、nano、heroku等CLI工具

使用场景

适用于所有Ruby项目开发，尤其适合需要：

• 避免依赖污染主机环境的场景
• 快速开发迭代（无需频繁构建镜像）
• 解决容器内文件权限问题（避免root用户生成文件）
• 便捷使用自动依赖安装、持久化历史等开发功能的场景

使用方法

环境配置

在项目根目录创建docker-compose.yml文件，内容如下：

yaml
version: "3"
volumes:
  bundle:       { driver: local }  # 本地卷驱动，存储Ruby gems
  node_modules: { driver: local }  # 本地卷驱动，存储NPM包
  config:       { driver: local }  # 本地卷驱动，存储配置文件
services:
  app:
    image: docker.xuanyuan.run/alpinelab/ruby-dev  # 可指定Ruby版本，如alpinelab/ruby-dev:<ruby-version>
    ports: ["5000:5000"]       # 根据项目需求映射端口（如Rails默认3000端口）
    volumes:
      - .:/app                 # 主机当前目录挂载到容器内/app
      - bundle:/bundle         # 挂载bundle卷到容器内/bundle
      - node_modules:/app/node_modules  # 挂载node_modules卷到容器内/app/node_modules
      - config:/config         # 挂载config卷到容器内/config

💡 可使用alpinelab/ruby-dev:<ruby-version>指定Ruby版本，支持多种版本，详见https://hub.docker.com/r/alpinelab/ruby-dev/tags/

运行项目

启动服务

通过以下命令启动项目（默认执行foreman start，启动Procfile中定义的服务）：

shell
docker-compose up

执行命令

运行任意命令（如rake、bash等）：

shell
docker-compose run app [rake|bash|...]

💡 无需在命令前添加bundle exec前缀（如直接执行docker-compose run app rake db:migrate）

绕过依赖检查

如需跳过命令执行前的依赖检查（bundle install/yarn install），可通过命令行覆盖入口点：

shell
docker-compose run --entrypoint=bypass app bash  # 直接启动bash，不检查依赖

自定义镜像

如需安装额外软件，可基于此镜像构建自定义镜像：

1. 在项目根目录创建Dockerfile：

   Dockerfile
   FROM docker.xuanyuan.run/alpinelab/ruby-dev  # 基于alpinelab/ruby-dev构建
   
   # 安装额外APT包（示例：安装curl）
   RUN apt-get update \
    && apt-get install --assume-yes --no-install-recommends --no-install-suggests \
         curl \  # 替换为所需软件包
    && rm -rf /var/lib/apt/lists/*  # 清理APT缓存，减小镜像体积
   

2. 修改docker-compose.yml，使用自定义构建镜像：

   yaml
   services:
     app:
       build: .  # 替换image字段为build: .，从当前目录Dockerfile构建
       # 其他配置（ports、volumes等）保持不变
   

ℹ️ 临时安装软件（如调试）：可在容器内直接执行apt-get update && apt-get install <软件包>

已知问题

• MacOS下node_modules权限问题：可能出现root所有的node_modules目录，这是由于Docker创建挂载点时的默认行为。未来将通过配置Yarn使用绝对路径存储模块解决（详见https://github.com/alpinelab/docker-ruby-dev/issues/1%EF%BC%89%E3%80%82

未维护版本

以下Ruby版本已停止维护：

• Ruby 2.2（https://www.ruby-lang.org/en/news/2018/06/20/support-of-ruby-2-2-has-ended/%EF%BC%89
• Ruby 2.3（https://www.ruby-lang.org/en/news/2019/03/31/support-of-ruby-2-3-has-ended/%EF%BC%89

DockerHub上仍有这些版本的镜像标签，但Git仓库中相关分支已移除，不再自动构建新镜像，视为过时版本。

贡献

欢迎通过https://github.com/alpinelab/docker-ruby-dev/pulls%E6%88%96https://github.com/alpinelab/docker-ruby-dev/issues%E8%B4%A1%E7%8C%AE%E4%BB%A3%E7%A0%81%E6%88%96%E5%8F%8D%E9%A6%88%E9%97%AE%E9%A2%98 ❤️

项目提供便捷脚本：

• https://github.com/alpinelab/docker-ruby-dev/blob/latest/add-ruby-version-support.sh%EF%BC%9A%E6%B7%BB%E5%8A%A0%E5%AF%B9%E6%96%B0Ruby%E7%89%88%E6%9C%AC%E7%9A%84%E6%94%AF%E6%8C%81
• https://github.com/alpinelab/docker-ruby-dev/blob/latest/rebase-all.sh%EF%BC%9A%E5%B0%86%60latest%60%E5%88%86%E6%94%AF%E7%9A%84%E5%8F%98%E6%9B%B4%E5%90%8C%E6%AD%A5%E5%88%B0%E5%85%B6%E4%BB%96%E5%88%86%E6%94%AF

许可证

本项目由Alpine Lab开发，基于MIT许可证开源。