doc/build-helpers/special/fhs-environments.section.md

   1 # buildFHSEnv {#sec-fhs-environments}
   2
   3 `buildFHSEnv` provides a way to build and run FHS-compatible lightweight sandboxes. It creates an isolated root filesystem with the host's `/nix/store`, so its footprint in terms of disk space is quite small. This allows you to run software which is hard or unfeasible to patch for NixOS; 3rd-party source trees with FHS assumptions, games distributed as tarballs, software with integrity checking and/or external self-updated binaries for instance.
   4 It uses Linux' namespaces feature to create temporary lightweight environments which are destroyed after all child processes exit, without requiring elevated privileges. It works similar to containerisation technology such as Docker or FlatPak but provides no security-relevant separation from the host system.
   5
   6 Accepted arguments are:
   7
   8 - `name`
   9         The name of the environment, and the wrapper executable if `pname` is unset.
  10 - `pname`
  11         The pname of the environment and the wrapper executable.
  12 - `version`
  13         The version of the environment.
  14 - `targetPkgs`
  15         Packages to be installed for the main host's architecture (i.e. x86_64 on x86_64 installations). Along with libraries binaries are also installed.
  16 - `multiPkgs`
  17         Packages to be installed for all architectures supported by a host (i.e. i686 and x86_64 on x86_64 installations). Only libraries are installed by default.
  18 - `multiArch`
  19         Whether to install 32bit multiPkgs into the FHSEnv in 64bit environments
  20 - `extraBuildCommands`
  21         Additional commands to be executed for finalizing the directory structure.
  22 - `extraBuildCommandsMulti`
  23         Like `extraBuildCommands`, but executed only on multilib architectures.
  24 - `extraOutputsToInstall`
  25         Additional derivation outputs to be linked for both target and multi-architecture packages.
  26 - `extraInstallCommands`
  27         Additional commands to be executed for finalizing the derivation with runner script.
  28 - `runScript`
  29         A shell command to be executed inside the sandbox. It defaults to `bash`. Command line arguments passed to the resulting wrapper are appended to this command by default.
  30         This command must be escaped; i.e. `"foo app" --do-stuff --with "some file"`. See `lib.escapeShellArgs`.
  31 - `profile`
  32         Optional script for `/etc/profile` within the sandbox.
  33
  34 You can create a simple environment using a `shell.nix` like this:
  35
  36 ```nix
  37 { pkgs ? import <nixpkgs> {} }:
  38
  39 (pkgs.buildFHSEnv {
  40   name = "simple-x11-env";
  41   targetPkgs = pkgs: (with pkgs; [
  42     udev
  43     alsa-lib
  44   ]) ++ (with pkgs.xorg; [
  45     libX11
  46     libXcursor
  47     libXrandr
  48   ]);
  49   multiPkgs = pkgs: (with pkgs; [
  50     udev
  51     alsa-lib
  52   ]);
  53   runScript = "bash";
  54 }).env
  55 ```
  56
  57 Running `nix-shell` on it would drop you into a shell inside an FHS env where those libraries and binaries are available in FHS-compliant paths. Applications that expect an FHS structure (i.e. proprietary binaries) can run inside this environment without modification.
  58 You can build a wrapper by running your binary in `runScript`, e.g. `./bin/start.sh`. Relative paths work as expected.
  59
  60 Additionally, the FHS builder links all relocated gsettings-schemas (the glib setup-hook moves them to `share/gsettings-schemas/${name}/glib-2.0/schemas`) to their standard FHS location. This means you don't need to wrap binaries with `wrapGApps*` hook.