Skip to content

Commit 6abc274

Browse files
committed
adding page on user controlled variables (eg, cache)
1 parent bbc685f commit 6abc274

3 files changed

Lines changed: 43 additions & 5 deletions

File tree

_data/sidebars/user_docs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,11 @@ entries:
3131
url: /docs-content
3232
output: web, pdf
3333

34-
- title: Bind Paths and Files
34+
- title: User Control
35+
url: /docs-control
36+
output: web, pdf
37+
38+
- title: Bind Paths and Mounts
3539
url: /docs-mount
3640
output: web, pdf
3741

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Controlling Your Build
3+
sidebar: user_docs
4+
permalink: user-control
5+
folder: docs
6+
---
7+
8+
This document will cover various environment variables that you can set to control the build of your image. If you are looking for the admin setup for Singularity on a shared resource, see the separate <a href="/admin-guide">Singularity Administration Guide</a>.
9+
10+
11+
## Cache Folders
12+
To make download of layers for <a href="/docs-import">import</a> and <a href="/docs-pull">pull</a> faster and less redundant, we use a caching strategy. By default, the Singularity software will create a set of folders in your `$HOME` directory for docker layers, Singularity Hub images, and Docker metadata, respectively:
13+
14+
```
15+
$HOME/.singularity
16+
$HOME/.singularity/docker
17+
$HOME/.singularity/shub
18+
$HOME/.singularity/metadata
19+
```
20+
21+
Fear not, you have control to customize this behavior! If you don't want the cache to be created (and a temporary directory will be used), set `SINGULARITY_DISABLE_CACHE` to True/yes, or if you want to move it elsewhere, set `SINGULARITY_CACHEDIR` to the full path where you want to cache. Remember that when you run commands as sudo (for example, with <a href="/docs-bootstrap">bootstrap</a> this will use root's home at `/root` and not your user's home.
22+
23+
## Pull Folder
24+
For details about customizing the output location of <a href="/docs-pull">pull</a>, see the<a href="/docs-pull">pull docs.</a> You have the similar ability to set it to be something different, or to customize the name of the pulled image.
25+
26+
27+
## Support
28+
29+
Have a question, or need further information? <a href="/support">Reach out to us.</a>

pages/docs/user-docs/user-guide.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,10 +161,15 @@ One the left side, you have your laptop, workstation, or a server that you contr
161161
### Examples
162162
How do the commands work? We recommend you look at examples for each:
163163

164-
- [shell](/docs-shell)
165-
- [exec](/docs-exec)
166-
- [run](/docs-run)
167-
- [bootstrap](/docs-bootstrap)
164+
- [bootstrap](/docs-bootstrap): Bootstrap a Singularity build specification to build an image
165+
- [exec](/docs-exec): Execute a command to your container
166+
- [inspect](/docs-inspect): See labels, run and test scripts, and environment variables
167+
- [import](/docs-import): import layers or other file content to your image
168+
- [pull](/docs-pull): pull an image from Docker or Singularity Hub
169+
- [run](/docs-run): Run your image as an executable
170+
- [shell](/docs-shell): Shell into your image
171+
- [user control](/docs-control): The environment commands you can set to control the workflow
172+
168173

169174

170175
## Support

0 commit comments

Comments
 (0)