Skip to content

Allow UI base url to be customizable #3957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 2, 2017
Merged

Allow UI base url to be customizable #3957

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5db4131
Allow UI base url to be customizable
mrparkers Nov 28, 2017
a6dd9d6
Add documentation to README
mrparkers Nov 28, 2017
8223710
Merge branch 'master' into base-url
mrparkers Nov 29, 2017
d003df2
Merge branch 'master' into base-url
shockey Nov 30, 2017
13eed0d
Merge branch 'master' into base-url
mrparkers Dec 1, 2017
3ee4f8d
Merge branch 'master' into base-url
shockey Dec 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ ENV OAUTH_APP_NAME "**None**"
ENV OAUTH_ADDITIONAL_PARAMS "**None**"
ENV SWAGGER_JSON "/app/swagger.json"
ENV PORT 80
ENV BASE_URL ""

RUN apk add --update nginx
RUN mkdir -p /run/nginx
Expand Down
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions docker-run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ replace_or_delete_in_index () {
fi
}

if [ "${BASE_URL}" ]; then
NGINX_WITH_BASE_URL="${NGINX_ROOT}${BASE_URL}"

mkdir -p ${NGINX_WITH_BASE_URL}
mv ${NGINX_ROOT}/*.* ${NGINX_WITH_BASE_URL}/
Copy link
Contributor

@shockey shockey Nov 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this behave when the container is run multiple times? I think it would nest the folder each time, i.e. /swagger then /swagger/swagger and so on.

Copy link
Contributor Author

@mrparkers mrparkers Nov 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The state of the container is reset when you kill it, so each time you run the container, this script runs against a fresh file system, with all of the UI files in /usr/share/nginx/html.

I verified this locally by running it multiple times with the same base url, and a few times with the url switched back and forth to something else. Each time it worked as expected.


INDEX_FILE=$NGINX_WITH_BASE_URL/index.html
NGINX_ROOT=$NGINX_WITH_BASE_URL
fi

replace_in_index myApiKeyXXXX123456789 $API_KEY
replace_or_delete_in_index your-client-id $OAUTH_CLIENT_ID
replace_or_delete_in_index your-client-secret-if-required $OAUTH_CLIENT_SECRET
Expand Down