Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-15 05:16:41 +03:00
Code Issues Packages Projects Releases Wiki Activity
05e0a3f06b
redoc/config/docker
History
Neel Kamath 63ec3d120c
Update README.md (#1130)
2020-05-09 14:32:27 +03:00
..
hooks doc: fix some typos (#1117) 2019-12-10 08:13:37 +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: migrate yarn -> npm 2020-03-17 11:06:03 +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 Update README.md (#1130) 2020-05-09 14:32:27 +03: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' 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

Serve local file and watch for updates:

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