seo | ||
---|---|---|
|
Redoc is available as a pre-built Docker image in Docker Hub.
If you have Docker installed, pull the image with the following command:
docker pull redocly/redoc
Then run the image with the following command:
docker run -p 8080:80 redocly/redoc
The preview starts on port 8080, based on the port used in the command,
and can be accessed at http://localhost:8080
.
To exit the preview, use control+C
.
By default Redoc starts with a demo Swagger Petstore OpenAPI definition located at
http://petstore.swagger.io/v2/swagger.json. You can update this URL using
the environment variable SPEC_URL
.
For example:
docker run -p 8080:80 -e SPEC_URL=https://api.example.com/openapi.json redocly/redoc
You can also create a Dockerfile with some predefined environment variables. Check out a sample Dockerfile in our code repo.