aboutsummaryrefslogtreecommitdiffhomepage
path: root/options.md
diff options
context:
space:
mode:
authorOphestra <cat@gensokyo.uk>2026-07-07 18:32:56 +0900
committerOphestra <cat@gensokyo.uk>2026-07-07 18:56:27 +0900
commit6d55ee536e902d059380f79e870d06547627cc7c (patch)
treeaacf3e3ec42525cf0e7a674aa948359fd0c21ae2 /options.md
parentc8e8651694415d497b0800319b2ddda361b7651f (diff)
test: move nix files
These are too much clutter. Move them to test directory until the test suite replacement is upstreamed. Signed-off-by: Ophestra <cat@gensokyo.uk>
Diffstat (limited to 'options.md')
-rw-r--r--options.md1175
1 files changed, 0 insertions, 1175 deletions
diff --git a/options.md b/options.md
deleted file mode 100644
index 6f6acddd..00000000
--- a/options.md
+++ /dev/null
@@ -1,1175 +0,0 @@
-## environment\.hakurei\.enable
-
-
-
-Whether to enable hakurei\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.package
-
-
-
-The hakurei package to use\.
-
-
-
-*Type:*
-package
-
-
-
-*Default:*
-
-```nix
-<derivation hakurei-static-x86_64-unknown-linux-musl-0.4.3>
-```
-
-
-
-## environment\.hakurei\.apps
-
-Declaratively configured hakurei apps\.
-
-
-
-*Type:*
-attribute set of (submodule)
-
-
-
-*Default:*
-
-```nix
-{ }
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.enablements\.dbus
-
-
-
-Whether to proxy D-Bus\.
-
-
-
-*Type:*
-null or boolean
-
-
-
-*Default:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.enablements\.pipewire
-
-
-
-Whether to share the PipeWire server via pipewire-pulse on a SecurityContext socket\.
-
-
-
-*Type:*
-null or boolean
-
-
-
-*Default:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.enablements\.wayland
-
-
-
-Whether to share the Wayland server via security-context-v1\.
-
-
-
-*Type:*
-null or boolean
-
-
-
-*Default:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.enablements\.x11
-
-
-
-Whether to share the X11 socket and allow connection\.
-
-
-
-*Type:*
-null or boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.packages
-
-
-
-List of extra packages to install via home-manager\.
-
-
-
-*Type:*
-list of package
-
-
-
-*Default:*
-
-```nix
-[ ]
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.args
-
-
-
-Custom args\.
-Setting this to null will default to script name\.
-
-
-
-*Type:*
-null or (list of string)
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.command
-
-
-
-Command to run as the target user\.
-Setting this to null will default command to launcher name\.
-Has no effect when script is set\.
-
-
-
-*Type:*
-null or string
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.dbus\.session
-
-
-
-D-Bus session bus custom configuration\.
-Setting this to null will enable built-in defaults\.
-
-
-
-*Type:*
-null or (function that evaluates to a(n) anything)
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.dbus\.system
-
-
-
-D-Bus system bus custom configuration\.
-Setting this to null will disable the system bus proxy\.
-
-
-
-*Type:*
-null or anything
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.devel
-
-
-
-Whether to enable debugging-related kernel interfaces\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.device
-
-
-
-Whether to enable access to all devices\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.env
-
-
-
-Environment variables to set for the initial process in the sandbox\.
-
-
-
-*Type:*
-null or (attribute set of string)
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.extraConfig
-
-
-
-Extra home-manager configuration\.
-
-
-
-*Type:*
-anything
-
-
-
-*Default:*
-
-```nix
-{ }
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.extraPaths
-
-
-
-Extra paths to make available to the container\.
-
-
-
-*Type:*
-list of attribute set of anything
-
-
-
-*Default:*
-
-```nix
-[ ]
-```
-
-
-
-## 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:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.groups
-
-
-
-List of groups to inherit from the privileged user\.
-
-
-
-*Type:*
-list of string
-
-
-
-*Default:*
-
-```nix
-[ ]
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.hostAbstract
-
-
-
-Whether to enable share abstract unix socket scope\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.hostNet
-
-
-
-Whether to enable share host net namespace\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-true
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.identity
-
-
-
-Application identity\. Identity 0 is reserved for system services\.
-
-
-
-*Type:*
-integer between 1 and 9999 (both inclusive)
-
-
-
-## environment\.hakurei\.apps\.\<name>\.insecureWayland
-
-
-
-Whether to enable direct access to the Wayland socket\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.mapRealUid
-
-
-
-Whether to enable mapping to priv-user uid\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.multiarch
-
-
-
-Whether to enable multiarch kernel-level support\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.name
-
-
-
-Name of the app’s launcher script\.
-
-
-
-*Type:*
-string
-
-
-
-## environment\.hakurei\.apps\.\<name>\.nix
-
-
-
-Whether to enable nix daemon access\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.path
-
-
-
-Custom executable path\.
-Setting this to null will default to the start script\.
-
-
-
-*Type:*
-null or string
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.schedPolicy
-
-
-
-Scheduling policy to set for the container\.
-The zero value retains the current scheduling policy\.
-
-
-
-*Type:*
-null or one of “fifo”, “rr”, “batch”, “idle”, “deadline”, “ext”
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.schedPriority
-
-
-
-Scheduling priority to set for the container\.
-
-
-
-*Type:*
-null or integer between 1 and 99 (both inclusive)
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.script
-
-
-
-Application launch script\.
-
-
-
-*Type:*
-null or string
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.share
-
-
-
-Package containing share files\.
-Setting this to null will default package name to wrapper name\.
-
-
-
-*Type:*
-null or package
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.shareRuntime
-
-
-
-Whether to enable sharing of XDG_RUNTIME_DIR between containers under the same identity\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.shareTmpdir
-
-
-
-Whether to enable sharing of TMPDIR between containers under the same identity\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.shareUid
-
-
-
-Whether to enable sharing identity with another application\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.tty
-
-
-
-Whether to enable access to the controlling terminal\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.useCommonPaths
-
-
-
-Whether to enable common extra paths\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-true
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.userns
-
-
-
-Whether to enable user namespace creation\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.verbose
-
-
-
-Whether to enable launchers with verbose output\.
-
-
-
-*Type:*
-boolean
-
-
-
-*Default:*
-
-```nix
-false
-```
-
-
-
-*Example:*
-
-```nix
-true
-```
-
-
-
-## environment\.hakurei\.apps\.\<name>\.wait_delay
-
-
-
-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:*
-null or signed integer
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.commonPaths
-
-
-
-Common extra paths to make available to the container\.
-
-
-
-*Type:*
-list of attribute set of anything
-
-
-
-*Default:*
-
-```nix
-[ ]
-```
-
-
-
-## environment\.hakurei\.extraHomeConfig
-
-
-
-Extra home-manager configuration to merge with all target users\.
-
-
-
-*Type:*
-anything
-
-
-
-## environment\.hakurei\.hsuPackage
-
-
-
-The hsu package to use\.
-
-
-
-*Type:*
-package
-
-
-
-*Default:*
-
-```nix
-<derivation hakurei-hsu-0.4.3>
-```
-
-
-
-## environment\.hakurei\.sharefs\.package
-
-
-
-The sharefs package to use\.
-
-
-
-*Type:*
-package
-
-
-
-*Default:*
-
-```nix
-<derivation sharefs>
-```
-
-
-
-## environment\.hakurei\.sharefs\.group
-
-
-
-Name of the group to run the sharefs daemon as\.
-
-
-
-*Type:*
-string
-
-
-
-*Default:*
-
-```nix
-"sharefs"
-```
-
-
-
-## environment\.hakurei\.sharefs\.name
-
-
-
-Host path to mount sharefs on\.
-
-
-
-*Type:*
-string
-
-
-
-*Default:*
-
-```nix
-"/sdcard"
-```
-
-
-
-## environment\.hakurei\.sharefs\.source
-
-
-
-Writable backing directory\. Setting this to null disables sharefs\.
-
-
-
-*Type:*
-null or string
-
-
-
-*Default:*
-
-```nix
-null
-```
-
-
-
-## environment\.hakurei\.sharefs\.user
-
-
-
-Name of the user to run the sharefs daemon as\.
-
-
-
-*Type:*
-string
-
-
-
-*Default:*
-
-```nix
-"sharefs"
-```
-
-
-
-## environment\.hakurei\.shell
-
-
-
-Absolute path to preferred shell\.
-
-
-
-*Type:*
-string
-
-
-
-*Default:*
-
-```nix
-"/run/current-system/sw/bin/bash"
-```
-
-
-
-## environment\.hakurei\.stateDir
-
-
-
-The state directory where app home directories are stored\.
-
-
-
-*Type:*
-string
-
-
-
-## environment\.hakurei\.users
-
-
-
-Users allowed to spawn hakurei apps and their corresponding hakurei identity\.
-
-
-
-*Type:*
-attribute set of integer between 0 and 99 (both inclusive)
-
-
-
-*Default:*
-
-```nix
-{ }
-```
-
-