Skip to content
This repository has been archived by the owner on Jun 14, 2023. It is now read-only.

Commit

Permalink
update release documentation for 1.0.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
bbortt committed Oct 4, 2021
1 parent e8d9290 commit 14f1f01
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ according to SemVer. It uses the [`docker/metadata-action`](https://github.com/d
| Event | Ref | Docker Tags |
|-----------------|-------------------------------|-------------------------------------|
| `pull_request` | `refs/pull/2/merge` | `pr-2` |
| `push` | `refs/heads/master` | `master` |
| `push` | `refs/heads/release` | `release` |
| `push` | `refs/heads/releases/v1` | `releases-v1` |
| `push tag` | `refs/tags/v1.2.3` | `1.2.3`, `1.2`, `latest` |
| `push tag` | `refs/tags/v2.0.8-beta.67` | `2.0.8-beta.67` |
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,14 @@ You must set the following environment variables to run the Docker container:

* `POLL_URL`: URL pointing towards a swagger configuration file (see [configuration / swagger](#swagger))

### Advanced

It optionally accepts the following arguments:

* `POLL_INTERVAL_SECONDS`: The refresh interval in seconds.
* Default is 300 (5 minutes).
* `SWAGGER_ROOT`: The swagger root folder, if using custom nginx configuration.
* Default ist `/usr/share/nginx/html`.

The default exposed port is 8080.

Expand Down Expand Up @@ -68,4 +72,4 @@ docker run \
# License

This project is licensed under the terms of
the [MIT License](https://github.com/postfinance/polling-swagger-ui/blob/canary/LICENSE).
the [MIT License](https://github.com/postfinance/polling-swagger-ui/blob/release/LICENSE).

0 comments on commit 14f1f01

Please sign in to comment.