redoc icon indicating copy to clipboard operation
redoc copied to clipboard

Official docker image for redoc-cli

Open douggish opened this issue 5 years ago • 10 comments

I found the official docker image for redoc here: https://hub.docker.com/r/redocly/redoc. However, I was not able to find an official docker image for redoc-cli (although I did find a Dockerfile for it here: https://github.com/Redocly/redoc/blob/master/cli/Dockerfile). It would be nice if there was an official docker image for redoc-cli that could be used during a CI build to generate static API documentation.

douggish avatar Jan 21 '20 21:01 douggish

Yes please!

FeepingCreature avatar Feb 10 '20 06:02 FeepingCreature

PR would be much appreciated!

RomanHotsiy avatar May 09 '20 12:05 RomanHotsiy

I found the official docker image for redoc here: https://hub.docker.com/r/redocly/redoc. However, I was not able to find an official docker image for redoc-cli (although I did find a Dockerfile for it here: https://github.com/Redocly/redoc/blob/master/cli/Dockerfile). It would be nice if there was an official docker image for redoc-cli that could be used during a CI build to generate static API documentation.

Built and pushed a docker image for redoc-cli from that Dockerfile. It's not official, but works for me for now. https://hub.docker.com/r/broothie/redoc-cli

broothie avatar Jun 11 '20 18:06 broothie

Built and pushed a docker image for redoc-cli from that Dockerfile. It's not official, but works for me for now. https://hub.docker.com/r/broothie/redoc-cli

Why not PR the Dockerfile into the repo?

kierans avatar Sep 24 '20 04:09 kierans

Built and pushed a docker image for redoc-cli from that Dockerfile. It's not official, but works for me for now. https://hub.docker.com/r/broothie/redoc-cli

Why not PR the Dockerfile into the repo?

As the author said, the Dockerfile already exists in the repo. It's just not being built and pushed to Dockerhub

j616 avatar Sep 27 '20 10:09 j616

@j616 Thanks for pointing that out. I clearly didn't read the comment properly 😆

kierans avatar Oct 03 '20 05:10 kierans

Assume this issue can be closed now due to https://github.com/Redocly/redoc/pull/1614

Latest docker image is now pushed to github package and available at https://github.com/Redocly/redoc/pkgs/container/redoc%2Fcli

elsewhat avatar Dec 03 '21 12:12 elsewhat

@skadinna can we add the link to thee image above to the readme somewhere? Then we can close this issue.

RomanHotsiy avatar Feb 17 '22 09:02 RomanHotsiy

In a directory where swagger.yaml exists, run:

docker run --rm -v $(pwd):/api --workdir /api ghcr.io/redocly/redoc/cli:v2.0.0-rc.63 bundle swagger.yaml

Which will create redoc-static.html. Woot! 🎉 Thanks @elsewhat !

ericslandry avatar Feb 17 '22 16:02 ericslandry

Now it works with a latest tag as well

osavchenko avatar Sep 06 '22 18:09 osavchenko

Please use the new CLI version, the instructions for Docker are here: https://redocly.com/docs/cli/installation/#a-iddockerarun-commands-inside-docker

lornajane avatar Jul 19 '23 16:07 lornajane