mirror of https://github.com/Redocly/redoc.git synced 2024-11-10 19:06:34 +03:00

History

Roman Hotsiy d78029a04e chore: move repo to Redocly org		2019-06-04 15:47:22 +03:00
..
hooks	chore: use docker build hook to use Dockerfile from other location	2018-11-06 16:56:56 +02:00
docker-run.sh	docker: Incorrect port after restart when PORT is 8080 (#776 )	2019-01-10 10:06:51 +02:00
Dockerfile	chore: move Dockerfile to config/docker	2018-11-06 15:30:04 +02:00
index.tpl.html	fix: allow docker container serving under non-root URLs (#731 )	2018-12-11 15:27:12 +02:00
nginx.conf	chore: Add Dockerfile for easier deployment (#427 )	2018-06-25 14:10:29 +03:00
README.md	chore: move repo to Redocly org	2019-06-04 15:47:22 +03:00

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' redocly/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 redocly/redoc

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

docker build -t redocly/redoc .