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: docs/module.md
+9-18Lines changed: 9 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -281,7 +281,7 @@ This feature requires the use of a local or shared file system for the pipeline
281
281
282
282
Modules are designed to be easy to share and re-use across different pipelines, which helps eliminate duplicate work and spread improvements throughout the community. There are several ways to share modules:
283
283
284
-
- Use the Nextflow module registry system (recommended, see below)
284
+
- Use the Nextflow module registry (recommended, see below)
285
285
- Simply copy the module files into your pipeline repository
286
286
- Use [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to fetch modules from other Git repositories without maintaining a separate copy
287
287
- Use the [nf-core](https://nf-co.re/tools#modules) CLI to install and update modules with a standard approach used by the nf-core community
@@ -293,7 +293,7 @@ Modules are designed to be easy to share and re-use across different pipelines,
293
293
:::{versionadded} 26.04.0
294
294
:::
295
295
296
-
Nextflow provides a module registry system that enables you to install, share, and manage reusable modules from centralized registries. This system provides version management, integrity checking, and seamless integration with the Nextflow DSL.
296
+
Nextflow provides a module registry that enables you to install, share, and manage modules from centralized registries. This system provides version management, integrity checking, and seamless integration with the Nextflow DSL.
297
297
298
298
### Installing modules from a registry
299
299
@@ -338,15 +338,6 @@ Module versions are tracked in `nextflow_spec.json` in your project directory:
338
338
}
339
339
```
340
340
341
-
You can also configure versions in `nextflow.config`:
342
-
343
-
```nextflow
344
-
modules {
345
-
'@nf-core/fastqc' = '1.0.0'
346
-
'@nf-core/bwa-align' = '1.2.0'
347
-
}
348
-
```
349
-
350
341
When you run your workflow, Nextflow automatically installs or updates modules to match the specified versions.
351
342
352
343
### Discovering modules
@@ -364,7 +355,7 @@ List installed modules in your project:
364
355
$ nextflow module list
365
356
```
366
357
367
-
### Module integrity protection
358
+
### Module checksum verification
368
359
369
360
Nextflow automatically verifies module integrity using checksums. If you modify a module locally, Nextflow will detect the change and prevent accidental overwrites:
370
361
@@ -417,7 +408,7 @@ Your module directory must include:
417
408
418
409
Authentication is required for publishing and can be provided via the `NXF_REGISTRY_TOKEN` environment variable or in your configuration:
0 commit comments