2024-04-30 20:32:21 -04:00
dbus Update documentation to reflect 5e9211a530 2024-04-05 23:59:50 -04:00
filesystems Further documentation and overhaul of the help menu CLI 2024-03-30 21:47:20 -04:00
modules Update documentation to reflect 5e9211a530 2024-04-05 23:59:50 -04:00 Documentation update 2024-04-23 19:20:02 -04:00 Manual update to reflect c243d528b1 2024-04-30 20:32:21 -04:00 Updated docs/ 2024-02-12 23:28:01 -05:00

Getting started

Be sure to read the manuals here and here.

Creating containers

To create a base container, execute the following command:

$ pacwrap -Syucbt base

Then to create a container segment named common with a common set of packages, and an aggregate container named steam built up of these two containers, execute the following command sequence:

$ pacwrap -Syucst common --dep=base mesa gtk3 nvidia-utils -cat steam steam --dep=base,common

And finally, to launch steam inside of a fresh, aggregated container:

$ pacwrap run steam steam

You might've noticed that last step didn't work. That's because each container is locked down with a tight permission set by default.

Container configuration

Then you might be wondering: How do I use this with anything?

To explain that, first a little bit of background: Pacwrap implements a DSL (Domain Specific Language) with YAML. Containers are configured with this DSL to permiss access to filesystems, devices, UNIX sockets, networking, etc..

For example, here's a sample configuration of a container environment used for playing Steam games:

container_type: Aggregate
- base
- common
- steam
meta_version: 1706515223
enable_userns: true
retain_session: false
seccomp: true
allow_forking: true
- mount: root
- mount: home
- mount: sysfs
- mount: to_root
  - path: /usr/share/icons
  - path: /usr/share/fonts
  - path: /etc/fonts
  - permission: rw
    path: /media/Storage/Games/Steam
    dest: /mnt/SteamLibrary
- mount: to_home
  - path: .config/fontconfig/
- module: net
- module: gpu
- module: display
- module: pulseaudio
- module: dev
  - input
- module: env
  - var: LANG
  - var: QT_X11_NO_MITSHM
    set: '1'
- module: appindicator

Configuration Modules

Each base and aggregate type container can make use of filesystems, permissions, and dbus modules. These provide a good, ergonomic way to abstract these problems, whilst minimising complexity, providing a flexible human-readable configuration language.

You then might wonder: What are the individual modules, and what do each of them do? Here's a small breakdown of what some of them do below:

Networking module

- module: net

net permission module instructs bubblewrap to provide host networking to the container.

Display module

- module: display

display permission module detects, validates, and provides an X11 or Wayland (if available) display socket to the container.

GPU module

- module: gpu

gpu permission module binds your system's graphics devices to the container.

Home bind module

- mount: to_home
  - permission: rw
    path: Documents
  - permission: ro
    path: .config/fontconfig

to_home mount module provides an easy way to mount files or directories from your home folder into the container's home directory. In this example, we mount our Documents folder with read/write permissions, and our .config/fontconfig directory with read-only permissions.


  • Configuration files: ~/.config/pacwrap/
  • Container data stores: ~/.local/share/pacwrap/
  • Package caches: ~/.cache/pacwrap/pkg/

Further documentation

Documentation on each module, breaking down the individual options, can be found here.