mirror of
https://github.com/Redocly/redoc.git
synced 2025-03-01 00:20:33 +03:00
docs: Add information to README about Docker image & Docker Hub (#676)
closes #657
This commit is contained in:
parent
a6652542f3
commit
97db54aa2e
13
README.md
13
README.md
|
@ -5,7 +5,7 @@
|
||||||
|
|
||||||
[](https://travis-ci.org/Rebilly/ReDoc) [](https://coveralls.io/github/Rebilly/ReDoc?branch=master) [](https://david-dm.org/Rebilly/ReDoc) [](https://david-dm.org/Rebilly/ReDoc#info=devDependencies) [](https://www.npmjs.com/package/redoc) [](https://github.com/Rebilly/ReDoc/blob/master/LICENSE)
|
[](https://travis-ci.org/Rebilly/ReDoc) [](https://coveralls.io/github/Rebilly/ReDoc?branch=master) [](https://david-dm.org/Rebilly/ReDoc) [](https://david-dm.org/Rebilly/ReDoc#info=devDependencies) [](https://www.npmjs.com/package/redoc) [](https://github.com/Rebilly/ReDoc/blob/master/LICENSE)
|
||||||
|
|
||||||
[](https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js) [](https://www.npmjs.com/package/redoc) [](https://www.jsdelivr.com/package/npm/redoc)
|
[](https://cdn.jsdelivr.net/npm/redoc/bundles/redoc.standalone.js) [](https://www.npmjs.com/package/redoc) [](https://www.jsdelivr.com/package/npm/redoc) [](https://hub.docker.com/r/redocly/redoc/)
|
||||||
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
@ -184,6 +184,17 @@ You can also specify `onLoaded` callback which will be called each time Redoc ha
|
||||||
/>
|
/>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## The Docker way
|
||||||
|
|
||||||
|
ReDoc is available as pre-built Docker image in official [Docker Hub repository](https://hub.docker.com/r/redocly/redoc/). You may simply pull & run it:
|
||||||
|
|
||||||
|
docker pull redocly/redoc
|
||||||
|
docker run -p 80:8080 redocly/redoc
|
||||||
|
|
||||||
|
Also you may rewrite some predefined environment variables defined in [Dockerfile](./Dockerfile). By default ReDoc starts with demo Petstore spec located at `http://petstore.swagger.io/v2/swagger.json`, but you may change this URL using environment variable `SPEC_URL`:
|
||||||
|
|
||||||
|
docker run -p 80:8080 -e SPEC_URL=https://api.example.com/openapi.json redocly/redoc
|
||||||
|
|
||||||
## ReDoc CLI
|
## ReDoc CLI
|
||||||
|
|
||||||
[See here](https://github.com/Rebilly/ReDoc/blob/master/cli/README.md)
|
[See here](https://github.com/Rebilly/ReDoc/blob/master/cli/README.md)
|
||||||
|
|
Loading…
Reference in New Issue
Block a user