about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorRobert Hensing <robert@roberthensing.nl>2021-10-01 15:53:30 +0200
committerRobert Hensing <robert@roberthensing.nl>2021-12-04 13:49:10 +0000
commit0e9bc9ffd107c288571af4e3d4a9c2a6b64cf505 (patch)
tree36a94f9c1ade0e988305b83b28228c38eac7eb59 /doc
parent66c19d856bb4eece4dce7f35787126dd67274acd (diff)
dockerTools: Add fakechroot to fakeRootCommands
Diffstat (limited to 'doc')
-rw-r--r--doc/builders/images/dockertools.section.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/builders/images/dockertools.section.md b/doc/builders/images/dockertools.section.md
index bfe1d17a60674..af09f25222344 100644
--- a/doc/builders/images/dockertools.section.md
+++ b/doc/builders/images/dockertools.section.md
@@ -149,7 +149,13 @@ Create a Docker image with many of the store paths being on their own layer to i
 
 `fakeRootCommands` _optional_
 
-: Shell commands to run while creating the archive for the final layer in a fakeroot environment. Unlike `extraCommands`, you can run `chown` to change the owners of the files in the archive, changing fakeroot's state instead of the real filesystem. The latter would require privileges that the build user does not have. Static binaries do not interact with the fakeroot environment. By default all files in the archive will be owned by root.
+: Shell commands to run while creating the archive for the final layer in a fakeroot + fakechroot environment. Unlike `extraCommands`, you can run `chown` to change the owners of the files in the archive, changing fakeroot's state instead of the real filesystem. The latter would require privileges that the build user does not have. Static binaries do not interact with the fakeroot environment. By default all files in the archive will be owned by root.
+
+`enableFakechroot` _optional_
+
+: Whether to run in `fakeRootCommands` in `fakechroot`, making programs behave as though `/` is the root of the image being created, while files in the Nix store are available as usual. This allows most scripts that perform installation in `/` to work as expected. Considering that `fakechroot` is implemented via the same mechanism as `fakeroot`, it is not guaranteed to work and will not work for static binaries.
+
+    *Default:* `true` when built on Linux, `false` otherwise
 
 ### Behavior of `contents` in the final image {#dockerTools-buildLayeredImage-arg-contents}