Skip to content

Commit 522ee72

Browse files
committed
fixing outdated doc about /environment
1 parent 03da572 commit 522ee72

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

pages/docs/user-docs/docs-bootstrap-image.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,11 @@ Importing: /home/vanessa/.singularity/metadata/sha256:fe44851d529f465f9aa107b323
8282
When bootstrapping a container, it is best to consider the following:
8383

8484
1. Install packages, programs, data, and files into operating system locations (e.g. not `/home`, `/tmp`, or any other directories that might get commonly binded on).
85-
2. If you require any special environment variables to be defined, add them the `/environment` file inside the container.
86-
3. Files should never be owned by actual users, they should always be owned by a system account (UID < 500).
87-
4. Ensure that the container's `/etc/passwd`, `/etc/group`, `/etc/shadow`, and no other sensitive files have anything but the bare essentials within them.
88-
5. Do all of your bootstrapping via a definition file instead of manipulating the containers by hand (with the `--writable` options), this ensures greatest possibility of reproducibility and mitigates the *black box effect*.
85+
2. Make your container speak for itself. A good runscript will spit out usage, variables, and tell the user how to interact with the container.
86+
3. If you require any special environment variables to be defined, add them the `%environment` section of the bootstrap recipe.
87+
4. Files should never be owned by actual users, they should always be owned by a system account (UID < 500).
88+
5. Ensure that the container's `/etc/passwd`, `/etc/group`, `/etc/shadow`, and no other sensitive files have anything but the bare essentials within them.
89+
6. Do all of your bootstrapping via a definition file instead of manipulating the containers by hand (with the `--writable` options), this ensures greatest possibility of reproducibility and mitigates the *black box effect*.
8990

9091

9192

0 commit comments

Comments
 (0)