https://github.com/bfirsh/docker-redoc

A Docker image which serves ReDoc documentation
https://github.com/bfirsh/docker-redoc

Last synced: about 2 months ago
JSON representation

A Docker image which serves ReDoc documentation

• Host: GitHub
• URL: https://github.com/bfirsh/docker-redoc
• Owner: bfirsh
• License: other
• Created: 2016-12-02T16:34:10.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-11-07T05:25:02.000Z (about 6 years ago)
• Last Synced: 2024-12-07T07:03:17.624Z (about 2 months ago)
• Language: HTML
• Homepage:
• Size: 2.28 MB
• Stars: 11
• Watchers: 4
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - bfirsh/docker-redoc - A Docker image which serves ReDoc documentation (HTML)

README

        
# docker-redoc

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A Docker image which serves [ReDoc](https://rebilly.github.io/ReDoc/) documentation.

To serve `swagger.yaml` in the current directory:

    $ docker run -p 80:80 -v $(PWD)/swagger.yaml:/usr/share/nginx/html/swagger.yaml bfirsh/redoc

And it'll be running at [http://localhost](http://localhost).

### Example with custom runtime configuration

The following example illustrates customisation of runtime settings;

    $ docker run \

      -p 80:80 \

      -v $(PWD)/swagger.json:/usr/share/nginx/html/swagger.json \

      -e PAGE_TITLE="My API docs" \

      -e SPEC_URL=swagger.json \

      -e 'REDOC_OPTIONS=hide-hostname="true" lazy-rendering'\

      bfirsh/redoc

## Runtime configuration

This image can be configured at runtime, by setting environment variables;

- `PAGE_TITLE` sets the page-title (defaults to `ReDoc`)

- `SPEC_URL` URL of the Swagger file (defaults to `swagger.yaml`)

- `REDOC_OPTIONS` sets [`` tag attributes](https://github.com/Rebilly/ReDoc#redoc-tag-attributes)

## License

Copyright (c) 2016 Ben Firshman. Licensed under the [MIT license](LICENSE).