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
+39-5Lines changed: 39 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
This is a work-in-progress [Spring Boot](http://projects.spring.io/spring-boot/) MVC application which fetches [Common Workflow Language](http://www.commonwl.org/) files from a Github repository and creates a page for it detailing the main workflow and its inputs, outputs and steps.
4
4
5
-
[](https://travis-ci.org/common-workflow-language/cwlviewer)[](https://gitter.im/common-workflow-language/common-workflow-language?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)[](https://microbadger.com/images/commonworkflowlanguage/cwlviewer"Get your own image badge on microbadger.com")[](https://hub.docker.com/r/commonworkflowlanguage/cwlviewer/"Get your own version badge on microbadger.com")
If you change the source code, re-build with `docker-compose build`.
35
+
If you change the source code, then use this `docker-compose.override.yml` and
36
+
re-build with `docker-compose build`:
37
+
38
+
```yaml
39
+
version: '2'
40
+
services:
41
+
spring:
42
+
build: .
43
+
```
44
+
36
45
37
46
See the [docker-compose.yml](docker-compose.yml) file for details.
38
47
@@ -53,16 +62,41 @@ If you have modified the source code, then you may want to build the docker imag
53
62
You will need to have [MongoDB](https://www.mongodb.com/) running,
54
63
by default on `localhost:27017`.
55
64
56
-
(You can override this by supplying system properties like
57
-
`-Dspring.data.mongodb.host=mongo` or `-Dspring.data.mongodb.port=1337`)
65
+
If you are running from the command line, you can override this by supplying
66
+
system properties like `-Dspring.data.mongodb.host=mongo.example.org` and
67
+
`-Dspring.data.mongodb.port=1337`
58
68
59
69
If you have Docker, but are not using the Docker Compose method above,
60
70
you may start MongoDB with [Docker](https://www.docker.com/) using:
61
71
62
72
docker run --name cwlviewer-mongo -p 27017:27017 -d mongo
63
73
64
-
Note that this exposes mongodb to the world on port `27017`.
74
+
**WARNING**: The above expose mongodb to the world on port `27017`.
75
+
76
+
## Configuration
77
+
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
+
80
+
When deploying with docker, these can be overriden externally by creating/modifying `docker-compose.override.yml` as follows:
81
+
82
+
```yaml
83
+
version: '2'
84
+
services:
85
+
spring:
86
+
environment:
87
+
githubAPI.authentication: oauth
88
+
githubAPI.oauthToken: abcdefghhijklmnopqrstuvwxyz
89
+
```
90
+
91
+
The properties can alternatively be provided as system properties on the
92
+
command line, e.g. `-DgithubAPI.authentication=oauth`
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)
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.
65
98
99
+
OAuth tokens can be obtained using the [Github authorizations API](https://developer.github.com/v3/oauth_authorizations/).
0 commit comments