Install

One package has all of Domicile:

• domicile, which runs a shell, in a window or on the whole screen
• the Domicile login session
• manganese, the reference shell
• React and the @domicile-desktop/* packages a shell builds against

Install it from your distribution's package manager, or with Nix.

Domicile runs on x86_64 Linux and runs Wayland apps, with no Xwayland. GPUs, distributions and what is checked: What it runs on.

sudo curl -fsSL -o /etc/apt/keyrings/domicile.asc https://packages.domicile-desktop.com/domicile.ascecho "deb [signed-by=/etc/apt/keyrings/domicile.asc] https://packages.domicile-desktop.com/apt current main" |  sudo tee /etc/apt/sources.list.d/domicile.listsudo apt update && sudo apt install domicile

Your package manager keeps Domicile up to date. The repositories hold the three newest releases. This is the same install as manganese's (Install manganese).

After installing

On every distribution but NixOS:

1. Name the shell the login session runs in ~/.config/domicile/domicile.json: manganese, as here, or your own (The config file).

   { "shell": "@domicile-desktop/manganese" }

   Copy
2. Log out, and pick Domicile in your login screen.

You don't need the login session to write a shell: domicile ./shell.tsx runs one in a window on your current desktop. Start with the Shell quickstart.

Try it first

With Nix, run manganese in a window on your current desktop, with nothing installed:

nix run github:cprussin/domicile/release#manganese

nix run installs nothing on the system, so the password check the lock screen uses (/etc/pam.d/domicile) is missing. Without it the screen doesn't lock, not even when the machine sleeps, and a notification says so. To lock, install a package or add the file (LOCK.md).

The newest build

Packages of the newest stable build, before it is released, and Nix on another distribution: Install manganese and RUNNING-A-DESKTOP.md.