rapidoid Docker 镜像 - 轩辕镜像

弃用通知

此镜像因缺乏活跃维护已弃用（最后更新于2018年8月；docker-library/official-images#4667）。

如docker-library/official-images#4667 (comment)中所述，预计在Rapidoid 6发布后会再次更新。

快速参考

• 维护者：
  Rapidoid

• 获取帮助：
  Docker社区论坛、Docker社区Slack 或 Stack Overflow

支持的标签及对应的 Dockerfile 链接

• 5.4.6, 5.4, 5, latest

快速参考（续）

• 提交issue的位置：
  [***]

• 支持的架构：(更多信息)
  amd64、arm64v8

• 已发布镜像 artifact 详情：
  repo-info 仓库的 repos/rapidoid/ 目录（历史记录）
  （镜像元数据、传输大小等）

• 镜像更新：
  official-images 仓库的 library/rapidoid 标签
  official-images 仓库的 library/rapidoid 文件（历史记录）

• 此描述的来源：
  docs 仓库的 rapidoid/ 目录（历史记录）

什么是 Rapidoid？

Rapidoid 是一个极快的 HTTP 服务器和现代 Java Web 框架/应用容器，专注于高生产力和高性能。

[***]

!logo

如何使用此镜像

要快速启动 Rapidoid 并显示基本使用帮助，请运行：

console
$ docker run --rm rapidoid --help

Rapidoid 可通过多种方式使用：

• 作为 Web 工具，从命令行快速原型化 RESTful Web 服务
• 作为 HTTP 服务器，提供静态资源服务
• 作为 Java Web 应用框架/容器，部署 Web 应用 JAR

快速原型化 SQL 驱动的 RESTful Web 服务

要从命令行快速原型化 SQL 驱动的 RESTful Web 服务，需将数据库容器链接到 Rapidoid 容器。MySQL 容器应使用名称 mysql 链接，PostgreSQL 容器使用名称 postgres 链接。

以下示例启动一个新的 MySQL 容器，并在 Rapidoid 容器中以名称 mysql 链接，通过为路由 GET /users 指定 SQL 查询来定义 RESTful 服务。该服务以 JSON 格式返回结果（MySQL 用户列表）。

console
docker run -d --name some-mysql -e MYSQL_ROOT_PASSWORD=db-pass mysql

docker run -it --rm \
    -p 8888:8888 \
    --link some-mysql:mysql \
    rapidoid \
    profiles=mysql \
    jdbc.host=mysql \
    jdbc.password=db-pass \
    '/users <= SELECT user FROM mysql.user'

注意：请等待几秒让 MySQL 数据库初始化，然后可在 Web 浏览器中访问 http://localhost:8888/users（或 [***]）。

服务原型化参数语法：

console
'[GET|POST|PUT|DELETE|PATCH] <uri> <= <sql>'

提供静态文件服务

Rapidoid 会自动从 /app/static 文件夹提供静态文件。要提供 /your-www-root 目录的内容，请将其挂载为 /app/static：

console
$ docker run -it --rm \
    -p 8888:8888 \
    -v /your-www-root:/app/static \
    rapidoid

配置

Rapidoid 会尝试从 /app/config.yml 读取配置。配置也可通过命令行参数或环境变量指定。

要为默认服务器和 Admin 服务器配置自定义端口（默认 8888），运行以下命令。如果未配置 rapidoid-admin.port，默认服务器也会用作 Admin 服务器，因此只会打开一个端口（rapidoid.port）。

console
$ docker run -it --rm \
    -p 4444:4444 \
    -p 9999:9999 \
    rapidoid \
    rapidoid.port=4444 \
    rapidoid-admin.port=9999 \
    app.services=ping \
    admin.services=status

然后可在 Web 浏览器中访问 http://localhost:4444/_ping（或 [***]）和 http://localhost:9999/_status（或 [***]）。

相同设置可通过环境变量配置：

console
$ docker run -it --rm \
    -p 4444:4444 \
    -p 9999:9999 \
    -e RAPIDOID_PORT=4444 \
    -e RAPIDOID-ADMIN_PORT=9999 \
    rapidoid \
    app.services=ping \
    admin.services=status

更多详情，请参见 完整配置选项列表及其默认值。

安全

Rapidoid 的基于 HMAC 的安全令牌机制要求所有容器在扩展 Web 应用时共享相同的密钥：

console
$ docker run -it --rm \
    -p 8888:8888 \
    -e SECRET=your-secret-key \
    rapidoid

虽然这是快速开始的简便方法，但出于安全考虑，建议将密钥存储在 /app/config.yml 文件中，并设置适当的权限。

注意：生产环境中，必须将 your-secret-key 替换为真实的私有密钥。

注意：如果未指定密钥，将生成随机密钥，这在部署单个容器时是可接受的。

完整引导 Rapidoid 的 Admin Center

要在 Rapidoid 中引导完整的 Admin Center，还需为内置 admin 用户配置密码：

console
$ docker run -d \
    --restart=always \
    -p 8888:8888 \
    -e SECRET=your-secret-key \
    -e USERS_ADMIN_PASSWORD=admin-pass \
    rapidoid \
    admin.services=center

请将 admin-pass 替换为 admin 用户的真实密码。然后可通过在 Web 浏览器中访问 http://localhost:8888/_（或 [***]）登录 Admin Center。

注意：生产环境中，必须将 your-secret-key 替换为真实的私有密钥（参见“安全”部分）。

如何扩展此镜像（应用 JAR 部署）

要将此镜像用作 Web 应用的基础镜像，只需将应用 JAR 添加为 /app/app.jar：

dockerfile
COPY <location/of/your/webapp.jar> /app/app.jar

许可证

查看此镜像中包含软件的 许可证信息。

与所有 Docker 镜像一样，这些镜像可能还包含其他软件，这些软件可能采用其他许可证（如基础发行版中的 Bash 等，以及主要软件的任何直接或间接依赖项）。

一些能够自动检测到的额外许可证信息可能位于 repo-info 仓库的 rapidoid/ 目录 中。

对于任何预构建镜像的使用，镜像用户有责任确保对该镜像的任何使用都符合其中包含的所有软件的相关许可证。===SHORT_DESC=== 此镜像已弃用，因缺乏活跃维护（最后更新于2018年8月），可能在Rapidoid 6发布时恢复更新。 ===FULL_DESC===# 弃用通知

此镜像因缺乏活跃维护已弃用（最后更新于2018年8月；docker-library/official-images#4667）。

如docker-library/official-images#4667 (comment)中所述，预计在Rapidoid 6发布后可能会再次更新。

快速参考

• 维护者：
  Rapidoid

• 获取帮助：
  Docker社区论坛、Docker社区Slack 或 Stack Overflow

支持的标签及对应的 Dockerfile 链接

• 5.4.6, 5.4, 5, latest

快速参考（续）

• 提交issue的位置：
  [***]

• 支持的架构：(更多信息)
  amd64、arm64v8

• 已发布镜像 artifact 详情：
  repo-info 仓库的 repos/rapidoid/ 目录（历史记录）
  （镜像元数据、传输大小等）

• 镜像更新：
  official-images 仓库的 library/rapidoid 标签
  official-images 仓库的 library/rapidoid 文件（历史记录）

• 此描述的来源：
  docs 仓库的 rapidoid/ 目录（历史记录）

什么是 Rapidoid？

Rapidoid 是一个极快的 HTTP 服务器和现代 Java Web 框架/应用容器，专注于高生产力和高性能。

[***]

!logo

如何使用此镜像

要快速启动 Rapidoid 并显示基本使用帮助，请运行：

console
$ docker run --rm rapidoid --help

Rapidoid 可通过多种方式使用：

• 作为 Web 工具，从命令行快速原型化 RESTful Web 服务
• 作为 HTTP 服务器，提供静态资源服务
• 作为 Java Web 应用框架/容器，部署 Web 应用 JAR

快速原型化 SQL 驱动的 RESTful Web 服务

要从命令行快速原型化 SQL 驱动的 RESTful Web 服务，需将数据库容器链接到 Rapidoid 容器。MySQL 容器应使用名称 mysql 链接，PostgreSQL 容器使用名称 postgres 链接。

以下示例启动一个新的 MySQL 容器，并在 Rapidoid 容器中以名称 mysql 链接，通过为路由 GET /users 指定 SQL 查询来定义 RESTful 服务。该服务以 JSON 格式返回结果（MySQL 用户列表）。

console
docker run -d --name some-mysql -e MYSQL_ROOT_PASSWORD=db-pass mysql

docker run -it --rm \
    -p 8888:8888 \
    --link some-mysql:mysql \
    rapidoid \
    profiles=mysql \
    jdbc.host=mysql \
    jdbc.password=db-pass \
    '/users <= SELECT user FROM mysql.user'

注意：请等待几秒让 MySQL 数据库初始化，然后可在 Web 浏览器中访问 http://localhost:8888/users（或 [***]）。

服务原型化参数语法：

console
'[GET|POST|PUT|DELETE|PATCH] <uri> <= <sql>'

提供静态文件服务

Rapidoid 会自动从 /app/static 文件夹提供静态文件。要提供 /your-www-root 目录的内容，请将其挂载为 /app/static：

console
$ docker run -it --rm \
    -p 8888:8888 \
    -v /your-www-root:/app/static \
    rapidoid

配置

Rapidoid 会尝试从 /app/config.yml 读取配置。配置也可通过命令行参数或环境变量指定。

要为默认服务器和 Admin 服务器配置自定义端口（默认 8888），运行以下命令。如果未配置 rapidoid-admin.port，默认服务器也会用作 Admin 服务器，因此只会打开一个端口（rapidoid.port）。

console
$ docker run -it --rm \
    -p 4444:4444 \
    -p 9999:9999 \
    rapidoid \
    rapidoid.port=4444 \
    rapidoid-admin.port=9999 \
    app.services=ping \
    admin.services=status

然后可在 Web 浏览器中访问 http://localhost:4444/_ping（或 [***]）和 http://localhost:9999/_status（或 [***]）。

相同设置可通过环境变量配置：

console
$ docker run -it --rm \
    -p 4444:4444 \
    -p 9999:9999 \
    -e RAPIDOID_PORT=4444 \
    -e RAPIDOID-ADMIN_PORT=9999 \
    rapidoid \
    app.services=ping \
    admin.services=status

更多详情，请参见 完整配置选项列表及其默认值。

安全

Rapidoid 的基于 HMAC 的安全令牌机制要求所有容器在扩展 Web 应用时共享相同的密钥：

console
$ docker run -it --rm \
    -p 8888:8888 \
    -e SECRET=your-secret-key