Skip to content

Commit

Permalink
Update docs/config.md
Browse files Browse the repository at this point in the history
Co-authored-by: Patrick Hüther <patrick.huether@gmail.com>
Signed-off-by: Niklas Schandry <schandry@gmail.com>
Signed-off-by: Niklas Schandry <niklas@bio.lmu.de>
  • Loading branch information
nschan and phue committed Sep 12, 2024
1 parent 1b9b0e4 commit 4c3725a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,7 @@ The following settings are available:
: Enable Charliecloud execution (default: `false`).

`charliecloud.writeFake`
: Enable `writeFake` with charliecloud (default). This enables running containers from storage in writeable mode using overlayfs, see [charliecloud documentation](https://hpc.github.io/charliecloud/ch-run.html#ch-run-overlay) for details. Using this is recommended, given that the kernel supports it. If this option is enabled. `$CH_IMAGE_STORAGE` will be used as the preferred image storage directory.
: Enable `writeFake` with charliecloud (default: `true`). This enables running containers from storage in writeable mode using overlayfs, see [charliecloud documentation](https://hpc.github.io/charliecloud/ch-run.html#ch-run-overlay) for details. Using this is recommended, given that the kernel supports it. If this option is enabled, `$CH_IMAGE_STORAGE` will be used as the preferred image storage directory.

`charliecloud.cacheDir`
: The directory where remote Charliecloud images are stored. If `writeFake` is disabled, this _must_ be different from `$CH_IMAGE_STORAGE`. When using a computing cluster it must be a shared folder accessible to all compute nodes. If `charliecloud.cacheDir` is not set, nextflow will use `$NXF_CHARLIECLOUD_CACHE` (if set) or fall back to `work/charliecloud`.
Expand Down

0 comments on commit 4c3725a

Please sign in to comment.