commonworkflowlanguage/cwlviewer

CWL Viewer

镜像概述和主要用途

CWL Viewer 是一个基于 Spring Boot 的MVC应用程序，能够从GitHub仓库获取 Common Workflow Language (CWL) 文件，并生成详细页面，展示工作流程及其输入、输出和步骤信息。该镜像提供了便捷的Web界面，帮助用户可视化和理解CWL工作流程定义。

核心功能和特性

• CWL文件解析：从GitHub仓库获取CWL文件并解析其结构
• 工作流程可视化：生成包含工作流程、输入、输出和步骤的详细页面
• 多环境支持：提供生产实例、开发环境及本地部署选项
• Docker化部署：支持通过Docker和Docker Compose快速部署
• 数据持久化：可与PostgreSQL和Jena Fuseki等服务集成实现数据存储
• 配置灵活：支持通过环境变量、系统属性等多种方式自定义配置

使用场景和适用范围

• 生产环境：推荐使用官方生产实例 [***]
• 开发环境：供开发者本地调试和开发新功能
• 封闭环境：在内部网络或隔离环境中部署私有实例，满足特定安全需求

使用方法和配置说明

推荐 - 使用Docker运行

通过Docker和Docker Compose部署是推荐的运行或开发方式。

步骤1：克隆项目

bash
git clone https://github.com/common-workflow-language/cwlviewer.git
cd cwlviewer

步骤2：启动服务

在项目目录中，启动CWL Viewer并暴露8080端口：

bash
docker compose up

服务启动后，将显示"Tomcat started on port(s):8080"，此时可通过 http://localhost:8080/ 访问应用。

步骤3：停止服务

bash
docker compose down

步骤4：修改源码后重新构建

创建docker-compose.override.yml文件：

yaml
version: '3.9'
services:
  spring:
    build: .

然后重新构建并启动：

bash
docker compose build
docker compose up

本地构建Docker镜像

若修改了源码，可先本地构建镜像：

bash
docker build -t commonworkflowlanguage/cwlviewer .

本地开发（Spring Boot + Docker服务）

适用于需要本地运行Spring Boot，同时使用Docker运行PostgreSQL和Jena Fuseki的场景。

创建覆盖配置文件

创建docker-compose.override.yml：

yaml
version: '3.9'
services:
  postgres:
    ports:
     - "5432:5432"
  sparql:
    ports:
     - "3030:3030"

启动依赖服务

bash
docker compose up

本地运行Spring Boot

bash
mvn spring-boot:run -Dserver.port=7999

访问 http://localhost:7999 即可使用应用。

数据重置

如需完全重置状态，删除数据卷：

bash
docker compose down
docker volume rm cwlviewer_bundle cwlviewer_git cwlviewer_graphviz cwlviewer_postgres cwlviewer_sparql

配置说明

可通过多种方式自定义配置，配置选项详见 https://github.com/common-workflow-language/cwlviewer/blob/master/src/main/resources/application.properties%E3%80%82

Docker部署时覆盖配置

创建/修改docker-compose.override.yml设置环境变量：

yaml
version: '3.9'
services:
  spring:
    environment:
      applicationName: Common Workflow Language Viewer
      applicationURL: https://view.commonwl.org
      cacheDays: 1

命令行参数方式

作为系统属性传递：

bash
mvn spring-boot:run -DcacheDays=1

数据备份与恢复

备份（使用dump.py）

bash
# 备份指定页面的工作流程
python dump.py --viewer https://view.commonwl.org/ --output /var/backups --page 0 --size 100

# 备份所有工作流程
python dump.py -o /var/backups -a

恢复（使用load.py）

bash
./load.py /var/backups/cwl/2018-06-06T135133+0000.json.gz https://view.commonwl.org/

可选--no-commits参数跳过提交ID相关条目。

文档与资源

• 生产实例：[***]
• 问题反馈：Gitter聊天室
• 技术报告：10.5281/zenodo.823295
• 视频介绍：2017年视频概述

许可证

采用 Apache License, Version 2.0 许可协议，详见 https://github.com/common-workflow-language/cwlviewer/blob/main/LICENSE.md%E3%80%82

贡献

欢迎通过 https://github.com/common-workflow-language/cwlviewer/issues%E3%80%81https://github.com/common-workflow-language/cwlviewer/pulls 或加入 Gitter聊天室 参与贡献。

更新日志

详见 https://github.com/common-workflow-language/cwlviewer/blob/main/CHANGELOG.md