No description
  • Nix 50.8%
  • Haskell 49.1%
Find a file
Josh Heinrichs ff5dd74cbf Fix try-fwd-env setting unset variables
If an environment variable is unset, `try-fwd-env` will set it to an
empty string. This can cause issues for programs that treat unset and
empty environment variables differently. For instance, when jailing
Spotify with the `pulse` combinator, `$PULSE_SERVER` gets set to an
empty string, Spotify tries to use it as-is, fails, and then falls back
to using ALSA.

Ideally I would've liked to wire this into the existing env logic
somehow but it's a bit tricky to do since `--setenv` needs to be
provided to Bubblewrap conditionally based on a value that isn't known
until the script is executed. Bubblewrap appears to handle `--setenv`
being specified multiple times for the same variable okay, so not using
the existing env logic doesn't break the ability to override environment
variables.
2025-12-16 08:50:53 -08:00
lib Fix try-fwd-env setting unset variables 2025-12-16 08:50:53 -08:00
tests Add no-die-with-parent combinator 2025-12-16 08:50:53 -08:00
website Fix wrong brackets in advanced configuration docs 2025-10-28 12:37:58 -07:00
.build.yml Add repo to sources 2025-11-30 12:49:48 -08:00
default.nix Allow consuming jail.nix without flakes 2025-08-15 08:06:02 -07:00
flake.nix Restructure source 2025-08-07 15:54:50 -07:00
LICENSE Add initial spike 2025-04-27 12:07:03 -07:00
README.md Update readme 2025-10-19 11:51:46 -07:00

jail.nix builds.sr.ht status

Docs | Source | Issues | Patches | Matrix

A helper to make it easy and ergonomic to wrap your derivations in bubblewrap.

Getting Started

Documentation to install and get started can be found here.

Example

# flake.nix
{
  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";
  inputs.jail-nix.url = "sourcehut:~alexdavid/jail.nix";

  outputs = { nixpkgs, jail-nix, ... }: let
    pkgs = import nixpkgs { system = "x86_64-linux"; };
    jail = jail-nix.lib.init pkgs;

    untrusted-package = pkgs.writeScriptBin "untrusted" ''
      ls -la $HOME
    '';
  in {
    packages.x86_64-linux.jailed = jail "my-jail" untrusted-package (with jail.combinators; [
      # See combinators section below for more functions that can go here

      # Give program access to the network
      network

      # Allow program to create windows
      gui

      # Give program access to the GPU
      gpu

      # Give program read-only access to /var/log/journal
      (readonly "/var/log/journal")

      # Mount ~/foo to /bar in the jail as read-write
      # (noescape due to `~` — all arguments are shell escaped by default)
      (rw-bind (noescape "~/foo") "/bar")
    ]);
  };
}

Combinators

By default, only the bare minimum permissions are exposed. By passing combinators into the jail you can modify the jail to expose more permissions.

Click here for a full list of combinators and their documentation.

Help / Comments / Suggestions

I am working on docs with examples of combinators for various common software projects, but this isn't finished yet. In the meantime, if you need help jailing software, run into issues, or have suggestions, feel free to join #jail.nix:woh.place on matrix, or open an issue.