From a6dd9d60e7ecbdb4a742aef5ca33776b5e61b87f Mon Sep 17 00:00:00 2001 From: Michael Parker Date: Tue, 28 Nov 2017 13:22:34 -0600 Subject: [PATCH] Add documentation to README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index a912fdc3..b1b99ae2 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,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 `/`. + ##### Prerequisites - Node 6.x - NPM 3.x