Skip to content

Commit

Permalink
Add documentation about running offline
Browse files Browse the repository at this point in the history
  • Loading branch information
fa2k committed Jul 26, 2023
1 parent 8e33754 commit 5775355
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -393,3 +393,26 @@ We recommend adding the following line to your environment to limit this (typica
```bash
NXF_OPTS='-Xms1g -Xmx4g'
```

### Running the pipeline without Internet access

The pipeline and container images can be downloaded using [nf-core tools](https://nf-co.re/docs/usage/offline).
Here is an example command to download pipeline version 1.1.0 with singularity images:

```
nf-core download \
--container singularity \
--compress none \
--revision 1.1.0 \
raredisease
```

Contrary to the paragraph about Nextflow on the nf-core tools page, it is not possible to use the "-all" packaged version of Nextflow. The online version of nextflow is necessary to support the nextflow plugins used for this pipeline. Download instead the file called just `nextflow`. Nextflow will download its dependencies when it is run. Additionally, you need to download the nf-validation plugin explicitly:

```
./nextflow plugin install [email protected]
```

Now you can transfer the `nextflow` binary as well as its directory `$HOME/.nextflow` to the system without Internet access, and use it there.

For running offline, you of course have to make all the reference data available locally, and specify `--fasta`, etc., see [above](#reference-files-and-parameters).

0 comments on commit 5775355

Please sign in to comment.