You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,12 +73,11 @@ you may start MongoDB with [Docker](https://www.docker.com/) using:
73
73
74
74
**WARNING**: The above expose mongodb to the world on port `27017`.
75
75
76
-
## GitHub OAuth2 tokens
76
+
## Configuration
77
77
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.
79
79
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:
82
81
83
82
```yaml
84
83
version: '2'
@@ -91,8 +90,13 @@ services:
91
90
92
91
The properties can alternatively be provided as system properties on the
93
92
command line, e.g. `-DgithubAPI.authentication=oauth`
`-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)
95
94
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/).
0 commit comments