diff options
Diffstat (limited to 'options.md')
| -rw-r--r-- | options.md | 259 |
1 files changed, 60 insertions, 199 deletions
@@ -35,7 +35,7 @@ package *Default:* -` <derivation hakurei-static-x86_64-unknown-linux-musl-0.0.2> ` +` <derivation hakurei-static-x86_64-unknown-linux-musl-0.2.0> ` @@ -55,53 +55,52 @@ attribute set of (submodule) -## environment\.hakurei\.apps\.\<name>\.packages +## environment\.hakurei\.apps\.\<name>\.enablements\.dbus -List of extra packages to install via home-manager\. +Whether to proxy D-Bus\. *Type:* -list of package +null or boolean *Default:* -` [ ] ` +` true ` -## environment\.hakurei\.apps\.\<name>\.args +## environment\.hakurei\.apps\.\<name>\.enablements\.pulse -Custom args\. -Setting this to null will default to script name\. +Whether to share the PulseAudio socket and cookie\. *Type:* -null or (list of string) +null or boolean *Default:* -` null ` +` true ` -## environment\.hakurei\.apps\.\<name>\.capability\.dbus +## environment\.hakurei\.apps\.\<name>\.enablements\.wayland -Whether to proxy D-Bus\. +Whether to share the Wayland socket\. *Type:* -boolean +null or boolean @@ -110,57 +109,58 @@ boolean -## environment\.hakurei\.apps\.\<name>\.capability\.pulse +## environment\.hakurei\.apps\.\<name>\.enablements\.x11 -Whether to share the PulseAudio socket and cookie\. +Whether to share the X11 socket and allow connection\. *Type:* -boolean +null or boolean *Default:* -` true ` +` false ` -## environment\.hakurei\.apps\.\<name>\.capability\.wayland +## environment\.hakurei\.apps\.\<name>\.packages -Whether to share the Wayland socket\. +List of extra packages to install via home-manager\. *Type:* -boolean +list of package *Default:* -` true ` +` [ ] ` -## environment\.hakurei\.apps\.\<name>\.capability\.x11 +## environment\.hakurei\.apps\.\<name>\.args -Whether to share the X11 socket and allow connection\. +Custom args\. +Setting this to null will default to script name\. *Type:* -boolean +null or (list of string) *Default:* -` false ` +` null ` @@ -313,7 +313,7 @@ Extra paths to make available to the container\. *Type:* -list of (submodule) +anything @@ -322,52 +322,48 @@ list of (submodule) -## environment\.hakurei\.apps\.\<name>\.extraPaths\.\*\.dev +## environment\.hakurei\.apps\.\<name>\.gpu -Whether to enable use of device files\. +Target process GPU and driver access\. +Setting this to null will enable GPU whenever X or Wayland is enabled\. *Type:* -boolean +null or boolean *Default:* -` false ` - - - -*Example:* -` true ` +` null ` -## environment\.hakurei\.apps\.\<name>\.extraPaths\.\*\.dst +## environment\.hakurei\.apps\.\<name>\.groups -Mount point in container, same as src if null\. +List of groups to inherit from the privileged user\. *Type:* -null or string +list of string *Default:* -` null ` +` [ ] ` -## environment\.hakurei\.apps\.\<name>\.extraPaths\.\*\.require +## environment\.hakurei\.apps\.\<name>\.hostAbstract -Whether to enable start failure if the bind mount cannot be established for any reason\. +Whether to enable share abstract unix socket scope\. @@ -386,24 +382,11 @@ boolean -## environment\.hakurei\.apps\.\<name>\.extraPaths\.\*\.src +## environment\.hakurei\.apps\.\<name>\.hostNet -Host filesystem path to make available to the container\. - - - -*Type:* -string - - - -## environment\.hakurei\.apps\.\<name>\.extraPaths\.\*\.write - - - -Whether to enable mounting path as writable\. +Whether to enable share host net namespace\. @@ -413,7 +396,7 @@ boolean *Default:* -` false ` +` true ` @@ -422,43 +405,6 @@ boolean -## environment\.hakurei\.apps\.\<name>\.gpu - - - -Target process GPU and driver access\. -Setting this to null will enable GPU whenever X or Wayland is enabled\. - - - -*Type:* -null or boolean - - - -*Default:* -` null ` - - - -## environment\.hakurei\.apps\.\<name>\.groups - - - -List of groups to inherit from the privileged user\. - - - -*Type:* -list of string - - - -*Default:* -` [ ] ` - - - ## environment\.hakurei\.apps\.\<name>\.identity @@ -554,29 +500,6 @@ string -## environment\.hakurei\.apps\.\<name>\.net - - - -Whether to enable network access\. - - - -*Type:* -boolean - - - -*Default:* -` true ` - - - -*Example:* -` true ` - - - ## environment\.hakurei\.apps\.\<name>\.nix @@ -771,57 +694,18 @@ boolean -## environment\.hakurei\.commonPaths +## environment\.hakurei\.apps\.\<name>\.wait_delay -Common extra paths to make available to the container\. +Duration to wait for after interrupting a container’s initial process in nanoseconds\. +A negative value causes the container to be terminated immediately on cancellation\. +Setting this to null defaults to five seconds\. *Type:* -list of (submodule) - - - -*Default:* -` [ ] ` - - - -## environment\.hakurei\.commonPaths\.\*\.dev - - - -Whether to enable use of device files\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - - - -## environment\.hakurei\.commonPaths\.\*\.dst - - - -Mount point in container, same as src if null\. - - - -*Type:* -null or string +null or signed integer @@ -830,93 +714,70 @@ null or string -## environment\.hakurei\.commonPaths\.\*\.require +## environment\.hakurei\.commonPaths -Whether to enable start failure if the bind mount cannot be established for any reason\. +Common extra paths to make available to the container\. *Type:* -boolean +anything *Default:* -` false ` - - - -*Example:* -` true ` +` [ ] ` -## environment\.hakurei\.commonPaths\.\*\.src +## environment\.hakurei\.extraHomeConfig -Host filesystem path to make available to the container\. +Extra home-manager configuration to merge with all target users\. *Type:* -string +anything -## environment\.hakurei\.commonPaths\.\*\.write +## environment\.hakurei\.hsuPackage -Whether to enable mounting path as writable\. +The hsu package to use\. *Type:* -boolean +package *Default:* -` false ` - - - -*Example:* -` true ` - - - -## environment\.hakurei\.extraHomeConfig +` <derivation hakurei-hsu-0.2.0> ` -Extra home-manager configuration to merge with all target users\. - +## environment\.hakurei\.shell -*Type:* -anything - - -## environment\.hakurei\.hsuPackage - - - -The hsu package to use\. +Absolute path to preferred shell\. *Type:* -package +string *Default:* -` <derivation hakurei-hsu-0.0.2> ` +` "/run/current-system/sw/bin/bash" ` |