Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-25 18:13:44 +03:00
Code Issues Packages Projects Releases Wiki Activity
ebe8d3f68c
redoc/config/docker
History
Roman Hotsiy ebe8d3f68c
chore: use docker build hook to use Dockerfile from other location 
[ci skip]
2018-11-06 16:56:56 +02:00
..
hooks chore: use docker build hook to use Dockerfile from other location 2018-11-06 16:56:56 +02:00
docker-run.sh chore: Add Dockerfile for easier deployment (#427) 2018-06-25 14:10:29 +03:00
Dockerfile chore: move Dockerfile to config/docker 2018-11-06 15:30:04 +02:00
index.tpl.html chore: Add Dockerfile for easier deployment (#427) 2018-06-25 14:10:29 +03:00
nginx.conf chore: Add Dockerfile for easier deployment (#427) 2018-06-25 14:10:29 +03:00
README.md chore: move Dockerfile to config/docker 2018-11-06 15:30:04 +02:00

README.md

Official ReDoc Docker Image

Usage

Serve remote spec by URL:

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

Serve local file:

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

Runtime configuration options

  • PAGE_TITLE (default "ReDoc") - page title
  • PAGE_FAVICON (default "favicon.png") - URL to page favicon
  • SPEC_URL (default "http://petstore.swagger.io/v2/swagger.json") - URL to spec
  • PORT (default 80) - nginx port
  • REDOC_OPTIONS - <redoc> tag attributes

Build

docker build -t redoc .