mirror of
https://github.com/Redocly/redoc.git
synced 2024-12-05 06:43:43 +03:00
4512436f1d
* Add security headers to nginx config Increase the security of the nginx server and the served page, by adding the following security headers to the nginx config: - X-Frame-Options (Disables click jacking by disallowing the page to be run in a frame/iframe) - X-XSS-Protection (Enables cross site scripting filtering) - X-Content-Type-Options (Disables MIME sniffing and forces browser to use the type given in Content-Type.) - Content-Security-Policy (Controls resources the user agent is allowed to load for a given page.) - Referrer-Policy (Governs which referrer information sent in the Referer header should be included with requests made.) Additional headers that could be added optionally: - Strict-Transport-Security (Enforce HTTPS over HTTP) |
||
---|---|---|
.. | ||
hooks | ||
docker-run.sh | ||
Dockerfile | ||
index.tpl.html | ||
nginx.conf | ||
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 titlePAGE_FAVICON
(default"favicon.png"
) - URL to page faviconSPEC_URL
(default"http://petstore.swagger.io/v2/swagger.json"
) - URL to specPORT
(default80
) - nginx portREDOC_OPTIONS
-<redoc>
tag attributes
Build
docker build -t redocly/redoc .