Files
hakurei/options.md
T

689 lines
5.6 KiB
Markdown
Raw Normal View History

2024-11-19 18:12:35 +09:00
## environment\.fortify\.enable
Whether to enable fortify\.
*Type:*
boolean
*Default:*
` false `
*Example:*
` true `
## environment\.fortify\.package
The fortify package to use\.
*Type:*
package
*Default:*
2025-04-01 01:42:10 +09:00
` <derivation fortify-static-x86_64-unknown-linux-musl-0.3.3> `
2024-11-19 18:12:35 +09:00
## environment\.fortify\.apps
Declarative fortify apps\.
*Type:*
list of (submodule)
*Default:*
` [ ] `
## environment\.fortify\.apps\.\*\.packages
List of extra packages to install via home-manager\.
*Type:*
list of package
*Default:*
` [ ] `
2025-03-30 23:05:57 +09:00
## environment\.fortify\.apps\.\*\.args
Custom args\.
Setting this to null will default to script name\.
*Type:*
null or (list of string)
*Default:*
` null `
2024-11-19 18:12:35 +09:00
## environment\.fortify\.apps\.\*\.capability\.dbus
Whether to proxy D-Bus\.
*Type:*
boolean
*Default:*
` true `
## environment\.fortify\.apps\.\*\.capability\.pulse
Whether to share the PulseAudio socket and cookie\.
*Type:*
boolean
*Default:*
` true `
## environment\.fortify\.apps\.\*\.capability\.wayland
Whether to share the Wayland socket\.
*Type:*
boolean
*Default:*
` true `
## environment\.fortify\.apps\.\*\.capability\.x11
Whether to share the X11 socket and allow connection\.
*Type:*
boolean
*Default:*
` false `
## environment\.fortify\.apps\.\*\.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:*
` null `
## environment\.fortify\.apps\.\*\.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:*
` null `
## environment\.fortify\.apps\.\*\.dbus\.system
D-Bus system bus custom configuration\.
Setting this to null will disable the system bus proxy\.
*Type:*
null or anything
*Default:*
` null `
## environment\.fortify\.apps\.\*\.dev
2025-01-23 20:49:49 +09:00
Whether to enable access to all devices\.
*Type:*
boolean
*Default:*
` false `
*Example:*
` true `
## environment\.fortify\.apps\.\*\.devel
2025-03-26 02:18:59 +09:00
Whether to enable debugging-related kernel interfaces\.
2024-11-19 18:12:35 +09:00
*Type:*
boolean
*Default:*
` false `
*Example:*
` true `
## environment\.fortify\.apps\.\*\.env
Environment variables to set for the initial process in the sandbox\.
*Type:*
null or (attribute set of string)
*Default:*
` null `
## environment\.fortify\.apps\.\*\.extraConfig
Extra home-manager configuration\.
*Type:*
anything
*Default:*
` { } `
## environment\.fortify\.apps\.\*\.extraPaths
Extra paths to make available to the sandbox\.
*Type:*
list of anything
*Default:*
` [ ] `
## environment\.fortify\.apps\.\*\.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\.fortify\.apps\.\*\.groups
List of groups to inherit from the privileged user\.
*Type:*
list of string
*Default:*
` [ ] `
## environment\.fortify\.apps\.\*\.id
Freedesktop application ID\.
*Type:*
null or string
*Default:*
` null `
2025-02-15 23:03:13 +09:00
## environment\.fortify\.apps\.\*\.insecureWayland
Whether to enable direct access to the Wayland socket\.
*Type:*
boolean
*Default:*
` false `
*Example:*
` true `
2024-11-19 18:12:35 +09:00
## environment\.fortify\.apps\.\*\.mapRealUid
2025-01-23 20:49:49 +09:00
Whether to enable mapping to priv-user uid\.
*Type:*
boolean
*Default:*
` false `
*Example:*
` true `
## environment\.fortify\.apps\.\*\.multiarch
2025-03-26 02:18:59 +09:00
Whether to enable multiarch kernel-level support\.
2024-11-19 18:12:35 +09:00
*Type:*
boolean
*Default:*
` false `
*Example:*
` true `
## environment\.fortify\.apps\.\*\.name
Name of the apps launcher script\.
*Type:*
string
## environment\.fortify\.apps\.\*\.net
2025-01-23 20:49:49 +09:00
Whether to enable network access\.
2024-11-19 18:12:35 +09:00
*Type:*
boolean
*Default:*
` true `
*Example:*
` true `
## environment\.fortify\.apps\.\*\.nix
2025-03-26 02:18:59 +09:00
Whether to enable nix daemon access\.
2024-11-19 18:12:35 +09:00
*Type:*
boolean
*Default:*
` false `
*Example:*
` true `
2025-03-30 23:05:57 +09:00
## environment\.fortify\.apps\.\*\.path
Custom executable path\.
Setting this to null will default to the start script\.
*Type:*
null or string
*Default:*
` null `
2024-11-19 18:12:35 +09:00
## environment\.fortify\.apps\.\*\.script
Application launch script\.
*Type:*
null or string
*Default:*
` null `
## environment\.fortify\.apps\.\*\.share
Package containing share files\.
Setting this to null will default package name to wrapper name\.
*Type:*
null or package
*Default:*
` null `
2024-11-28 00:19:06 +09:00
## environment\.fortify\.apps\.\*\.tty
2025-01-23 20:49:49 +09:00
Whether to enable access to the controlling terminal\.
2024-11-28 00:19:06 +09:00
*Type:*
boolean
*Default:*
` false `
*Example:*
` true `
2024-11-19 18:12:35 +09:00
## environment\.fortify\.apps\.\*\.userns
2025-03-26 02:18:59 +09:00
Whether to enable user namespace creation\.
2024-11-19 18:12:35 +09:00
*Type:*
boolean
*Default:*
` false `
*Example:*
` true `
2025-01-23 20:49:49 +09:00
## environment\.fortify\.apps\.\*\.verbose
Whether to enable launchers with verbose output\.
*Type:*
boolean
*Default:*
` false `
*Example:*
` true `
2025-02-23 18:52:33 +09:00
## environment\.fortify\.fsuPackage
The fsu package to use\.
*Type:*
package
*Default:*
2025-04-01 01:42:10 +09:00
` <derivation fortify-fsu-0.3.3> `
2025-02-23 18:52:33 +09:00
2025-01-23 20:49:49 +09:00
## environment\.fortify\.home-manager
Target user shared home-manager configuration\.
*Type:*
function that evaluates to a(n) function that evaluates to a(n) attribute set of anything
2024-11-19 18:12:35 +09:00
## environment\.fortify\.stateDir
The state directory where app home directories are stored\.
*Type:*
string
## environment\.fortify\.users
Users allowed to spawn fortify apps and their corresponding fortify fid\.
*Type:*
attribute set of integer between 0 and 99 (both inclusive)