redocly/redoc

官方ReDoc Docker镜像

使用方法

Docker

通过URL提供远程规范：

docker run -it --rm -p 80:80 \
  -e SPEC_URL='http://localhost:8000/swagger.yaml' redocly/redoc

提供本地文件：

docker run -it --rm -p 80:80 \
  -v $(pwd)/demo/swagger.yaml:/usr/share/nginx/html/swagger.yaml \
  -e SPEC_URL=swagger.yaml redocly/redoc

提供本地文件并监听更新：

docker run -it --rm -p 80:80 \
  -v $(pwd)/demo/:/usr/share/nginx/html/swagger/ \
  -e SPEC_URL=swagger/swagger.yaml redocly/redoc

OpenShift

引用OpenShift容器平台特定指南：

支持任意用户ID

默认情况下，OpenShift容器平台使用任意分配的用户ID运行容器。这提供了额外的安全性，防止进程因容器引擎漏洞而逃离容器，从而在主机节点上获得提升的权限。

为使镜像支持以任意用户运行，镜像中可能被进程写入的目录和文件应归root组所有，并可被该组读写。要执行的文件还应具有组执行权限。

为符合这些要求，Dockerfile包含调整以下文件夹权限的指令：

• /etc/nginx：因为docker-run.sh脚本在启动时会修改它
• /usr/share/nginx/html：因为docker-run.sh脚本在启动时会修改它
• /var/cache/nginx：因为Nginx进程会写入该目录
• /var/log/nginx：因为Nginx进程会写入该目录
• /var/run：因为Nginx进程会写入该目录

OpenShift的另一个问题是默认暴露的端口80受限制，无法使用。因此需要使用其他端口（如8080，通过下文所述的PORT配置），并相应配置容器规范。

运行时配置选项

• PAGE_TITLE（默认值："ReDoc"）- 页面标题
• PAGE_FAVICON（默认值："favicon.png"）- 页面favicon的URL
• SPEC_URL（默认值："http://petstore.swagger.io/v2/swagger.json"）- 规范文件的URL
• PORT（默认值：80）- Nginx端口
• REDOC_OPTIONS - https://github.com/Redocly/redoc#redoc-tag-attributes

构建

docker build -t redocly/redoc .