Commit graph

32 commits

Author SHA1 Message Date
boyreau
9e4e4b82d4 Update documentation about non-flake usage 2026-06-22 22:31:45 +02:00
Alex David
731ba22f60 Add experimental combinator handling
I have a few combinator ideas that I'd like to try adding but I still
haven't fully fleshed them out yet. In order to reduce breaking people's
setup, this introduces a new `experimental` flag on combinators that
separates them on the docs website to let users know that their design
may not be fully finalized yet.
2026-04-14 22:27:44 -07:00
Alex David
7acd363b6d Implement combinator aliases
To make it easier to rename combinators without breaking anyone's
configuration, this change allows combinators to specify a list of
`aliases` that are also exported from `jail.combinators`.

The aliases are also documented on the documentation website.
2026-04-02 12:59:14 -07:00
Alex David
49aa817e4f Remove deprecated combinators
These have been deprecated for some time now, and were deprecated before
I gave my nixcon talk which brought attention to this library. So I
think it's pretty doubtful that anyone is still using these.
2026-04-02 12:18:47 -07:00
Alex David
da894f6e13 Move source link on docs website 2026-04-02 12:15:32 -07:00
Alex David
a06fc7d27f Use filesets to improve caching 2026-01-28 13:21:10 -08:00
Alex David
26d2149e42 Update to ghc 9.12 2026-01-28 10:10:01 -08:00
Alex David
bf9f49c811 Update tests and website to nixpkgs-25.11 2025-12-16 08:50:53 -08:00
Alex David
f777a5e2f3 Fix wrong brackets in advanced configuration docs 2025-10-28 12:37:58 -07:00
Alex David
b0a8a22983 Pull remaining default perms into base combinator
`base-permissions.nix` was the source of truth for all of the base
combinators, but it was not documented well anywhere.

To make this easier and more obvious for users, this commit pulls all
remaining custom permissions into a new `base` combinator which is
included by default. This way there is no more undocumented permissions
included by default, they are all documented in the `Default included
combinators` section of the docs.

This should also make it easier to override base permissions because
users can now just specify `base` instead of all of the
`unsafe-add-raw-args` calls unless they really want to change them.
2025-10-10 16:28:45 -07:00
Alex David
c4fb625497 Add website#serve app 2025-10-10 16:28:45 -07:00
Alex David
6181276ae1 Split combinators into files
The `lib/combinators.nix` file was getting quite long and some ideas I
have for future combinators may even require ancillary files. To help
scale these changes, this commit breaks each combinator into its own
file under the `lib/combinators` directory.
2025-10-10 16:28:43 -07:00
Alex David
700189112f Format nix files with nixfmt-tree 2025-09-11 07:31:48 -07:00
Alex David
39f7aaef09 Fix typo in website docs 2025-09-04 14:32:19 -07:00
Alex David
6fbd3729cc Add mkOverlay 2025-09-02 15:39:40 -07:00
Alex David
7dc202a5a7 Add dbus combinator 2025-09-01 21:47:48 -07:00
Alex David
275a1296e7 Fix network combinator binding too many paths 2025-09-01 21:47:48 -07:00
Alex David
d966d48182 Add Permission description to combinators docs 2025-08-27 12:14:55 -07:00
Alex David
8fe97d2ece Link to markdown files rather than relative links
Instead of needing to manually figure out these links, mkdocs will
automatically generate the correct relative path if you link to `.md`
files. Neat!
2025-08-15 08:31:06 -07:00
Alex David
1f3db346eb Update documentation nixpkgs branch 2025-08-15 08:14:35 -07:00
Alex David
c37ae887fd Allow consuming jail.nix without flakes 2025-08-15 08:06:02 -07:00
Alex David
d8500ab273 Move fake-passwd into combinators 2025-08-07 17:26:51 -07:00
Alex David
5e86199537 Include deprecated combinators in the docs 2025-08-07 17:23:52 -07:00
Alex David
595bc0e2e4 Allow overriding bubblewrap 2025-08-07 16:32:58 -07:00
Alex David
c7685334cf Restructure source 2025-08-07 15:54:50 -07:00
Alex David
09edd097b9 Clean up combinator/permission naming
The term `combinator` was overloaded before, being used to refer both to
the functions that are exposed to help build a jail, and their return
value to be passed into `jail`/`basePermissions`. This commit renames
the latter to `Permission`.
2025-08-07 15:42:36 -07:00
Alex David
f18f1cf701 Allow overriding jail base permissions 2025-08-07 15:29:16 -07:00
Alex David
c5ba72dc5a Make combinators available at jail.combinators
Instead of requiring the third argument to be a function that passes in
combinators, this exposes all combinators on `jail.combinators` and
allows the third argument to just be a list (or even null!). This may be
more ergonomic in some contexts (like nixpkgs overlays).

This isn't a breaking change, the third argument can still be a function
and will receive the combinators if it is.
2025-07-11 11:44:12 -07:00
Alex David
2f6e7c3078 Improve docs 2025-07-11 11:16:47 -07:00
Alex David
fce1224bdd Use __functor to simplify combinators
By using `__functor` combinators can call each other directly by using
`rec` rather than needing to mapAttrs over all of the combinators to
inject them into each one.
2025-06-13 22:14:13 -07:00
Alex David
f0fd252dd0 Add links to combinator implementations in docs 2025-06-07 14:36:51 -07:00
Alex David
6854d37560 Add initial docs website 2025-06-07 12:48:30 -07:00