Gem in a Box 技术文档

1. 安装指南

系统要求

• Ruby 版本：2.3 至 3.1（推荐使用 2.7、3.0 或 3.1）
• RubyGems 版本：2.5 至 3.3（推荐使用 2.5.2 或更高版本）

安装步骤

使用以下命令安装 Geminabox：

gem install geminabox

创建 config.ru 文件，内容如下：

require "rubygems"
require "geminabox"

Geminabox.data = "/var/geminabox-data" # 数据存放路径，可自定义

use Rack::Session::Pool, expire_after: 1000 # 设置会话超时时间
use Rack::Protection # 防止 XSS 和 CSRF 攻击

run Geminabox::Server

启动 gem 服务器，使用以下命令：

rackup

或者将其与您选择的 web 服务器（如 passenger、thin、unicorn 等）一起使用。

2. 项目使用说明

RubyGems 代理

Geminabox 可以配置为从 rubygems.org 拉取不存在的 gems。要启用此模式，可以在环境变量中设置 RUBYGEMS_PROXY 为 true，或者在 config.ru 中设置 Geminabox.rubygems_proxy 为 true。

如果希望在 rubygems.org 不可用的情况下继续提供 gems，可以在 config.ru 中添加 Geminabox.allow_remote_failure = true。

HTTP 适配器

Geminabox 使用 HTTPClient gem 管理对远程资源的连接。可以通过创建自定义 HTTPAdapter 来使用其他 HTTP gem。

钩子

可以添加一个钩子（任何可调用的对象），当成功接收到一个 gem 时会调用它。

命令行工具

使用 gem inabox 命令可以将 gem 推送到 Geminabox。

gem inabox pkg/my-awesome-gem-1.0.gem

还可以通过以下命令配置 Geminabox：

gem inabox -c

3. 项目 API 使用文档

Geminabox 支持 gemcutter push 和 yank API。

Push API

gem push pkg/my-awesome-gem-1.0.gem --host HOST

Yank API

gem yank my-awesome-gem -v 1.0 --host HOST

4. 项目安装方式

除了通过命令行安装外，还可以使用 Docker 进行安装。

创建 Dockerfile，将以下内容放入其中：

FROM ruby:2.7

RUN apt-get update -qq && apt-get install -y nodejs postgresql-client

WORKDIR /app

COPY Gemfile /app/Gemfile
COPY Gemfile.lock /app/Gemfile.lock
COPY config.ru /app/config.ru

RUN bundle install

CMD ["rackup", "config.ru", "-o", "0.0.0.0"]

构建镜像：

docker build -t geminabox .

运行容器：

docker run -d -p 9292:9292 geminabox:latest