Skip to content

Commit 0d7e968

Browse files
authored
Merge branch 'master' into hotfix-git-checkout
2 parents d3e2c80 + cf0e345 commit 0d7e968

File tree

3 files changed

+43
-28
lines changed

3 files changed

+43
-28
lines changed

README.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CWL Viewer
22

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.
3+
This is a [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.
44

55
[![Build Status](https://travis-ci.org/common-workflow-language/cwlviewer.svg?branch=master)](https://travis-ci.org/common-workflow-language/cwlviewer) [![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/common-workflow-language/cwlviewer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![](https://images.microbadger.com/badges/image/commonworkflowlanguage/cwlviewer.svg)](https://microbadger.com/images/commonworkflowlanguage/cwlviewer "MicroBadger commonworkflowlanguage/cwlviewer") [![Docker image commonworkflowlanguage/cwlviewer](https://images.microbadger.com/badges/version/commonworkflowlanguage/cwlviewer.svg)](https://hub.docker.com/r/commonworkflowlanguage/cwlviewer/ "Docker Hub commonworkflowlanguage/cwlviewer")
66
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.823534.svg)](https://doi.org/10.5281/zenodo.823534)
@@ -17,14 +17,14 @@ See the file [LICENSE.md](LICENSE.md) for details, and
1717

1818
Feel free to contribute! You may [raise an issue](https://github.com/common-workflow-language/cwlviewer/issues),
1919
provide a [pull request](https://github.com/common-workflow-language/cwlviewer/pulls)
20-
or join the [gitter chat for common-workflow-language](https://gitter.im/common-workflow-language/common-workflow-language)!
20+
or join the [gitter chat for cwlviewer](https://gitter.im/common-workflow-language/cwlviewer)!
2121

2222

2323
## Recommended - Running with Docker
2424

25-
This application can be started with [Docker](https://www.docker.com/).
25+
This application can be started with [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/install/).
2626

27-
If you have [Docker Compose](https://docs.docker.com/compose/install/), then to start CWLViewer exposed on port `8080`, run:
27+
To start CWLViewer exposed on port `8080`, run:
2828

2929
docker-compose up
3030

@@ -36,24 +36,14 @@ If you change the source code, then use this `docker-compose.override.yml` and
3636
re-build with `docker-compose build`:
3737

3838
```yaml
39-
version: '2'
39+
version: '3.2'
4040
services:
4141
spring:
4242
build: .
4343
```
4444
4545
See the [docker-compose.yml](docker-compose.yml) file for details.
4646
47-
If you don't want to use Docker Compose, you can do the equivalent manually with `docker`
48-
and the [commonworkflowlanguage/cwlviewer](https://hub.docker.com/r/commonworkflowlanguage/cwlviewer/builds/) docker image.
49-
50-
docker run --name cwlviewer-mongo -p 27017:27017 -d mongo
51-
docker run --name cwlviewer -p 8080:8080 --link cwlviewer-mongo:mongo -d commonworkflowlanguage/cwlviewer
52-
docker logs -f cwlviewer
53-
54-
55-
**WARNING**: Please ensure that your MongoDB installation is not exposed to the world on port `27017`
56-
5747
If you have modified the source code, then you may want to build the docker image locally first:
5848
5949
docker build -t commonworkflowlanguage/cwlviewer .
@@ -117,17 +107,17 @@ There are a variety of configuration options detailed in the [application config
117107
When deploying with docker, these can be overriden externally by creating/modifying `docker-compose.override.yml` as follows:
118108

119109
```yaml
120-
version: '2'
110+
version: '3.2'
121111
services:
122112
spring:
123113
environment:
124-
githubAPI.authentication: oauth
125-
githubAPI.oauthToken: abcdefghhijklmnopqrstuvwxyz
114+
applicationName: Common Workflow Language Viewer
115+
applicationURL: https://view.commonwl.org
116+
cacheDays: 1
126117
```
127118

128119
The properties can alternatively be provided as system properties on the
129-
command line, e.g. `-DgithubAPI.authentication=oauth`
130-
`-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)
120+
command line, e.g. `-DcacheDays=1` 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)
131121

132122
# Thanks
133123

docker-compose.yml

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,53 @@
1-
version: '2'
1+
version: '3.2'
2+
volumes:
3+
bundle:
4+
git:
5+
graphviz:
6+
mongo:
7+
sparql:
28
services:
39
spring:
410
# To run from this source code instead of Docker hub,
511
# disable "image:"" and enable "build:" below
6-
image: commonworkflowlanguage/cwlviewer
12+
image: commonworkflowlanguage/cwlviewer:v1.1.0
713
#build: .
814
ports:
915
- "8080:8080"
1016
links:
1117
- mongo
1218
- sparql
19+
volumes:
20+
- type: volume
21+
source: bundle
22+
target: /data/bundle
23+
- type: volume
24+
source: git
25+
target: /data/git
26+
- type: volume
27+
source: graphviz
28+
target: /data/graphviz
1329
environment:
1430
- SPARQL_ENDPOINT=http://sparql:3030/cwlviewer/
1531
- SPRING_DATA_MONGODB_HOST=mongo
1632
- SPRING_DATA_MONGODB_PORT=27017
33+
- BUNDLESTORAGE=/data/bundle
34+
- GITSTORAGE=/data/git
35+
- GRAPHVIZSTORAGE=/data/graphviz
1736
mongo:
18-
image: mongo
37+
image: mongo:3.4
38+
volumes:
39+
- type: volume
40+
source: mongo
41+
target: /data/db
1942
sparql:
2043
## For debugging, expose the Fuseki port by enabling:
2144
# ports:
2245
# - "3030:3030"
2346
## To find the admin password, try:
2447
## docker-compose exec sparql grep admin /fuseki/shiro.ini
25-
image: stain/jena-fuseki
26-
# FIXME: --loc=/fuseki/databases/cwlviewer fails as it needs empty dir
27-
command: "/jena-fuseki/fuseki-server --loc=/fuseki/databases /cwlviewer"
48+
image: stain/jena-fuseki:3.4.0
49+
volumes:
50+
- type: volume
51+
source: sparql
52+
target: /fuseki/databases
53+
command: "/jena-fuseki/fuseki-server --loc=/fuseki/databases/cwlviewer /cwlviewer"

src/main/resources/templates/index.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@ <h2>Workflow URL</h2>
5353
<strong>Don't know what to view?</strong> Try these from <i>common-workflow-language/workflows</i>:
5454
<a class="example" href="https://github.com/common-workflow-language/workflows/tree/master/workflows/compile/compile1.cwl">compile</a>,
5555
<a class="example" href="https://github.com/common-workflow-language/workflows/tree/master/workflows/make-to-cwl/dna.cwl">make-to-cwl</a>,
56-
<a class="example" href="https://github.com/common-workflow-language/workflows/tree/master/workflows/lobSTR/lobSTR-workflow.cwl">lobSTR</a>,
57-
<a class="example" href="https://github.com/common-workflow-language/workflows/tree/master/workflows/scidap/bam-genomecov-bigwig-rna-dutp.cwl">scidap</a>
56+
<a class="example" href="https://github.com/common-workflow-language/workflows/tree/lobstr-v1/workflows/lobSTR/lobSTR-workflow.cwl">lobSTR</a>
5857
or <a href="/workflows">explore the collection</a>
5958
</div>
6059
<form id="add" action="#" th:action="@{/workflows}" th:object="${workflowForm}" method="POST">

0 commit comments

Comments
 (0)