jail.nix/README.md

63 lines
1.9 KiB
Markdown
Raw Normal View History

2025-04-27 12:29:05 -07:00
# jail.nix
2025-08-15 08:19:53 -07:00
[![builds.sr.ht status](https://builds.sr.ht/~alexdavid/jail.nix/commits/main.svg)](https://builds.sr.ht/~alexdavid/jail.nix/commits/main?)
2025-04-27 12:29:05 -07:00
A helper to make it easy and ergonomic to wrap your derivations in
[bubblewrap](https://github.com/containers/bubblewrap).
2025-10-11 17:41:40 -07:00
Please report bugs and feature requests to the [issue
tracker](https://todo.sr.ht/~alexdavid/jail.nix). Please send patches,
questions and discussions to my [general mailing
2025-06-07 16:50:40 -07:00
list](https://lists.sr.ht/~alexdavid/general).
## Getting Started
Documentation to install and get started can be found
[here](https://alexdav.id/projects/jail-nix).
2025-04-27 12:29:05 -07:00
## Example
```nix
# 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
2025-04-27 12:29:05 -07:00
# Give program access to the network
network
2025-05-28 09:33:25 -07:00
# Allow program to create windows
2025-04-27 12:29:05 -07:00
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](https://alexdav.id/projects/jail-nix/combinators/) for a full list
of combinators and their documentation.