Skip to content

Commit 9d6fdb2

Browse files
authored
fix(docker): document new SwaggerUI docker registry usage (#10260)
1 parent bc9cfd5 commit 9d6fdb2

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

Diff for: .github/workflows/docker-image-check.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
- name: Run Trivy vulnerability scanner
1616
uses: aquasecurity/trivy-action@master
1717
with:
18-
image-ref: 'docker.io/swaggerapi/swagger-ui:unstable'
18+
image-ref: 'docker.swagger.io/swaggerapi/swagger-ui:unstable'
1919
format: 'table'
2020
exit-code: '1'
2121
ignore-unfixed: true

Diff for: README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
![total GitHub contributors](https://img.shields.io/github/contributors-anon/swagger-api/swagger-ui.svg)
77

88
![monthly npm installs](https://img.shields.io/npm/dm/swagger-ui.svg?label=npm%20downloads)
9-
![total docker pulls](https://img.shields.io/docker/pulls/swaggerapi/swagger-ui.svg)
9+
![docker registry](https://img.shields.io/badge/docker-docker.swagger.io%2Fswaggerapi%2Fswagger--ui-blue)
1010
![monthly packagist installs](https://img.shields.io/packagist/dm/swagger-api/swagger-ui.svg?label=packagist%20installs)
1111
![gzip size](https://img.shields.io/bundlephobia/minzip/swagger-ui.svg?label=gzip%20size)
1212

Diff for: docs/usage/installation.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -65,48 +65,48 @@ const ui = SwaggerUIBundle({
6565
You can pull a pre-built docker image of the swagger-ui directly from Docker Hub:
6666

6767
```sh
68-
docker pull swaggerapi/swagger-ui
69-
docker run -p 80:8080 swaggerapi/swagger-ui
68+
docker pull docker.swagger.io/swaggerapi/swagger-ui
69+
docker run -p 80:8080 docker.swagger.io/swaggerapi/swagger-ui
7070
```
7171

7272
Will start nginx with Swagger UI on port 80.
7373

7474
Or you can provide your own swagger.json on your host
7575

7676
```sh
77-
docker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui
77+
docker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo docker.swagger.io/swaggerapi/swagger-ui
7878
```
7979

8080
You can also provide a URL to a swagger.json on an external host:
8181

8282
```sh
83-
docker run -p 80:8080 -e SWAGGER_JSON_URL=https://petstore3.swagger.io/api/v3/openapi.json swaggerapi/swagger-ui
83+
docker run -p 80:8080 -e SWAGGER_JSON_URL=https://petstore3.swagger.io/api/v3/openapi.json docker.swagger.io/swaggerapi/swagger-ui
8484
```
8585

8686
The base URL of the web application can be changed by specifying the `BASE_URL` environment variable:
8787

8888
```sh
89-
docker run -p 80:8080 -e BASE_URL=/swagger -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui
89+
docker run -p 80:8080 -e BASE_URL=/swagger -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo docker.swagger.io/swaggerapi/swagger-ui
9090
```
9191

9292
This will serve Swagger UI at `/swagger` instead of `/`.
9393

9494
You can specify a different port via `PORT` variable for accessing the application, default is `8080`.
9595

9696
```sh
97-
docker run -p 80:80 -e PORT=80 swaggerapi/swagger-ui
97+
docker run -p 80:80 -e PORT=80 docker.swagger.io/swaggerapi/swagger-ui
9898
```
9999

100100
You can specify an IPv6 port via `PORT_IPV6` variable. By default, IPv6 port is not set.
101101

102102
```sh
103-
docker run -p 80:80 -e PORT_IPV6=8080 swaggerapi/swagger-ui
103+
docker run -p 80:80 -e PORT_IPV6=8080 docker.swagger.io/swaggerapi/swagger-ui
104104
```
105105

106106
You can allow/disallow [embedding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) via `EMBEDDING` variable. By default, embedding is disabled.
107107

108108
```sh
109-
docker run -p 80:80 -e EMBEDDING=true swaggerapi/swagger-ui
109+
docker run -p 80:80 -e EMBEDDING=true docker.swagger.io/swaggerapi/swagger-ui
110110
```
111111

112112
For more information on controlling Swagger UI through the Docker image, see the Docker section of the [Configuration documentation](configuration.md#docker).

0 commit comments

Comments
 (0)