Skip to content

Commit ecc68d2

Browse files
authored
Add configuration info to README.md
1 parent 8072b42 commit ecc68d2

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,11 @@ you may start MongoDB with [Docker](https://www.docker.com/) using:
7373

7474
**WARNING**: The above expose mongodb to the world on port `27017`.
7575

76-
## GitHub OAuth2 tokens
76+
## Configuration
7777

78-
If you run cwlviewer in production, you are likely to hit the GitHub API's rate limit of 500.
78+
There are a variety of configuration options detailed in the [application configuration file](https://github.com/common-workflow-language/cwlviewer/blob/master/src/main/resources/application.properties) which can be adjusted.
7979

80-
You can override this if you obtain an [OAuth token](https://developer.github.com/v3/oauth_authorizations/),
81-
which you can configure cwlviewer to use by creating/modifying `docker-compose.override.yml`:
80+
When deploying with docker, these can be overriden externally by creating/modifying `docker-compose.override.yml` as follows:
8281

8382
```yaml
8483
version: '2'
@@ -91,8 +90,13 @@ services:
9190

9291
The properties can alternatively be provided as system properties on the
9392
command line, e.g. `-DgithubAPI.authentication=oauth`
94-
`-DgithubAPI.oauthToken=abcdefghhijklmnopqrstuvwxyz`
93+
`-DgithubAPI.oauthToken=abcdefghhijklmnopqrstuvwxyz` or via a [variety of other methods supported by Spring Boot](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html)
9594

95+
### Github API
96+
97+
If you run cwlviewer in production, you are likely to hit the GitHub API's rate limit of 60 requests/hr. This can be increased to 5000 requests/hr by using authentication (either basic or OAuth) by setting the `githubAPI.authentication` and either `githubAPI.oauthToken` or both `githubAPI.username` and `githubAPI.password` in the [application configuration file](https://github.com/common-workflow-language/cwlviewer/blob/master/src/main/resources/application.properties) depending on the method.
98+
99+
OAuth tokens can be obtained using the [Github authorizations API](https://developer.github.com/v3/oauth_authorizations/).
96100

97101
## Building and Running
98102

0 commit comments

Comments
 (0)