Skip to content
This repository has been archived by the owner on Jan 30, 2025. It is now read-only.

Commit

Permalink
fix Markdown style
Browse files Browse the repository at this point in the history
Signed-off-by: KevinSayers <sayerskt@gmail.com>
  • Loading branch information
aglet authored and KevinSayers committed Nov 5, 2019
1 parent 7fe4219 commit f96ca6a
Showing 1 changed file with 29 additions and 34 deletions.
63 changes: 29 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,22 @@

# Intro

Nextflow Tower is an open source monitoring and management platform
for [Nextflow](https://www.nextflow.io/) workflows. Tower can be used to track your workflows wherever they run either locally,
on your cluster, in the cloud, or any combination of these. Learn more at [tower.nf](https://tower.nf/).

Nextflow Tower is an open source monitoring and management platform for [Nextflow](https://www.nextflow.io/) workflows. Tower can be used to track your workflows wherever they run either locally, on your cluster, in the cloud, or any combination of these. Learn more at [tower.nf](https://tower.nf/).

# Running locally

Nextflow Tower can be run locally using Docker, and requires only configuration of an SMTP for login emails.
Nextflow Tower can be run locally using Docker, and requires only configuration of an SMTP for login emails.

## Backend settings

The backend can be configured in one of two places:
- `application.yml` in the backend class-path (`tower-backend/src/main/resources/application.yml`)
- `tower.yml` in the launching directory

* `application.yml` in the backend class-path (`tower-backend/src/main/resources/application.yml`)
* `tower.yml` in the launching directory

An example minimal `tower.yml` is provided below.

```
``` yaml
tower:
contactEmail: nftower@example.com
---
Expand All @@ -35,62 +32,62 @@ mail:
password: password
```
## Build the environment
## Build the environment
make build
``` shellsession
make build
```

## Run locally

make run
``` shellsession
make run
```

See: `docker-compose.yml` file for details


## Basic use case

Navigate to the GUI at `http://localhost:8000` and follow the instructions to run your workflow with Tower.

Navigate to the GUI at `http://localhost:8000` and follow the instructions to run your workflow with Tower.

# Development
# Development

### Backend execution
## Backend execution

Define the following env variables:
Define the following env variables:

- TOWER_SMTP_USER=`<smtp user name>`
- TOWER_SMTP_PASSWORD=`<smpt password>`
* TOWER_SMTP_USER=`<smtp user name>`
* TOWER_SMTP_PASSWORD=`<smtp password>`

(see `tower-backend/src/main/resources/application.yml` for further config details)

Launch the backend with the command:
Launch the backend with the command:

```
``` shellsession
./gradlew tower-backend:run --continuous
```

### Frontend execution
## Frontend execution

```
``` shellsession
cd tower-web
npm install
npm run livedev
```

## Database

Tower is designed to be database agnostic and can use most popular SQL
database servers, such as MySql, Postgres, Oracle and many other.
## Database

By default it uses [H2](https://www.h2database.com), an embedded database meant to be used for evaluation purpose only.
Tower is designed to be database agnostic and can use most popular SQL database servers, such as MySQL, Postgres, Oracle and many others.

By default it uses [H2](https://www.h2database.com), an embedded database meant to be used for evaluation purpose only.

## Environment variables:
## Environment variables

* TOWER_APP_NAME: Application name.
* TOWER_SERVER_URL: Server URL e.g. `https://tower.nf`.
* TOWER_CONTACT_EMAIL: Sysadmin email contact e.g. `hello@tower.nf`.
* TOWER_DB_CREATE: DB creation policy e.g. `none`.
* TOWER_DB_URL: Database JDBC connection URL e.g. `jdbc:mysql://localhost:3307/tower`.
* TOWER_DB_URL: Database JDBC connection URL e.g. `jdbc:mysql://localhost:3307/tower`.
* TOWER_DB_DRIVER: Database JDBC driver class name e.g. `com.mysql.cj.jdbc.Driver`.
* TOWER_DB_DIALECT: Database SQL Hibernate dialect `org.hibernate.dialect.MySQL55Dialect`.
* TOWER_DB_USER: Database user name.
Expand All @@ -101,12 +98,10 @@ By default it uses [H2](https://www.h2database.com), an embedded database meant
* TOWER_SMTP_USER: SMTP server user name.
* TOWER_SMTP_PASSWORD: SMTP server user password.

## Support
## Support

* For common problems, doubts and feedback please use the [Gitter community channel](https://gitter.im/nf-tower/community)
or the [GitHub issues page](https://github.com/seqeralabs/nf-tower/issues).
* For common problems, doubts and feedback please use the [Gitter community channel](https://gitter.im/nf-tower/community) or the [GitHub issues page](https://github.com/seqeralabs/nf-tower/issues).
* Commercial support is provided by [Seqera Labs](https://www.seqera.io/).


## License

Expand Down

0 comments on commit f96ca6a

Please sign in to comment.