Subgraph

Configuring Realms

Realm configuration file reference

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

  • use-wayland
    If ’true’ access to Wayland display will be permitted in realm by adding wayland socket /run/user/1000/wayland-0
  • use-x11
    If ’true’ access to X11 server will be added to realm by bind mounting directory /tmp/.X11-unix
  • use-sound
    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
  • use-kvm
    If enabled, /dev/kvm will be added to the realm. This option is only available for nspawn realms.
  • use-shared-dir
    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.
  • use-ephemeral-home
    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
    1. Home directory is mounted as tmpfs
    2. Any files in /realms/skel are copied into home directory
    3. Any files in /realms/realm-${name}/skel are copied into home directory
    4. Any directories listed in ephemeral-persistent-dirs are bind mounted from /realms/realm-${name}/home into ephemeral home directory.
  • ephemeral-persistent-dirsdefault ["Documents"]
    A list of subdirectories of /realms/realm-${name}/home to bind mount into realm home directory when ephemeral-home is enabled.
  • use-network
    network
  • network-zonedefault "clear"
    network zone
  • use-gpu
    Enables hardware graphics acceleration in relam. if ’true’ render node device /dev/dri/renderD128 will be added to realm.
  • use-gpu-card0
    If ’true’ and use-gpu is also enabled, privileged device /dev/dri/card0 will be added to realm.
  • realmfsdefault "base"
    name of realmfs image
  • overlaydefault "storage"
    type of overlay to use
  • terminal-scheme
    terminal color scheme
  • extra-bindmounts
    bind mounts
  • extra-bindmounts-ro
    read-only bind mounts
  • system-realmdefault false
    system realm
  • autostartdefault false
    autostart realm