diff --git a/README.md b/README.md index f9b39079..b1be8c66 100644 --- a/README.md +++ b/README.md @@ -51,30 +51,6 @@ Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes ### How to run -##### Easy start! Docker -You can pull a pre-built docker image of the swagger-ui directly from Dockerhub: - -``` -docker pull swaggerapi/swagger-ui -docker run -p 80:8080 swaggerapi/swagger-ui -``` - -Will start nginx with swagger-ui on port 80. - -Or you can provide your own swagger.json on your host - -``` -docker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui -``` - -The base URL of the web application can be changed by specifying the `BASE_URL` environment variable: - -``` -docker run -p 80:8080 -e BASE_URL=/swagger -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui -``` - -This will serve Swagger UI at `/swagger` instead of `/`. - ##### Prerequisites - Node 6.x - NPM 3.x diff --git a/docs/usage/installation.md b/docs/usage/installation.md index 1a7f9ba7..fcf0e36c 100644 --- a/docs/usage/installation.md +++ b/docs/usage/installation.md @@ -52,6 +52,14 @@ Or you can provide your own swagger.json on your host docker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui ``` +The base URL of the web application can be changed by specifying the `BASE_URL` environment variable: + +``` +docker run -p 80:8080 -e BASE_URL=/swagger -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui +``` + +This will serve Swagger UI at `/swagger` instead of `/`. + ### unpkg You can embed Swagger-UI's code directly in your HTML by using unkpg's interface: