Realm configuration file reference Configuring Realms

Realms are usually configured with the tools for managing realms, but the configuration is stored in a TOML file in the realm directory and can also be edited by hand.

Options <code>use-wayland</code>

If 'true' access to Wayland display will be permitted in realm by adding wayland socket /run/user/1000/wayland-0

 <code>use-x11</code>

If 'true' access to X11 server will be added to realm by bind mounting directory /tmp/.X11-unix

 <code>use-sound</code>

If 'true' allows the use of sound inside realm. The following items will be added to realm:

/dev/snd

/dev/shm

/run/user/1000/pulse

 <code>use-kvm</code>

If enabled, /dev/kvm will be added to the realm. This option is only available for nspawn realms.

 <code>use-shared-dir</code>

If enabled the directory /realms/Shared will be bind mounted into the home directory of the realm. This directory is shared between all running realms that have this option enabled as a convenient way to move files between realms.

 <code>use-ephemeral-home</code>

If 'true' the home directory of this realm will be set up in ephemeral mode. The ephemeral home directory is set up with the following steps

Home directory is mounted as tmpfs

Any files in /realms/skel are copied into home directory

Any files in /realms/realm-${name}/skel are copied into home directory

Any directories listed in ephemeral-persistent-dirs are bind mounted from /realms/realm-${name}/home into ephemeral home directory.

 <code>ephemeral-persistent-dirs</code> default: ["Documents"]

A list of subdirectories of /realms/realm-${name}/home to bind mount into realm home directory when ephemeral-home is enabled.

 <code>use-network</code>

network

 <code>network-zone</code> default: "clear"

network zone

 <code>use-gpu</code>

Enables hardware graphics acceleration in relam. if 'true' render node device /dev/dri/renderD128 will be added to realm.

 <code>use-gpu-card0</code>

If 'true' and use-gpu is also enabled, privileged device /dev/dri/card0 will be added to realm.

 <code>realmfs</code> default: "base"

name of realmfs image

 <code>overlay</code> default: "storage"

type of overlay to use

 <code>terminal-scheme</code>

terminal color scheme

 <code>extra-bindmounts</code>

bind mounts

 <code>extra-bindmounts-ro</code>

read-only bind mounts

 <code>system-realm</code> default: false

system realm

 <code>autostart</code> default: false

autostart realm