maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore(tvix/docs): move daemon protocol to its own chapter

Browse source 
… and add an introductionary page at the root.

Change-Id: I89ce69a4221c332b7c0d99ac26b4e26bfd248341
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11806
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Reviewed-by: Brian Olsen <me@griff.name>
This commit is contained in:
Florian Klink 2024-06-13 21:55:24 +03:00 • committed by clbot
parent d947f61d36
commit c30fded880
2 changed files with 20 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
tvix/docs/src/nix-daemon/index.md Normal file
View file

@ -0,0 +1,15 @@
# Nix Daemon Protocol
The Nix Daemon protocol is what's used to communicate with the `nix-daemon`,
either on the local system (in which case the communication happens via a Unix
domain socket), or with a remote Nix (in which this is tunneled over SSH).
It uses a custom binary format which isn't too documented. The subpages here
collect serve as an in-depth detail about some of the inner workings, data types
etc.
A first implementation of this exists in
[griff/Nix.rs](https://github.com/griff/Nix.rs/tree/main).
Work is underway to port / factor this out into reusable building blocks into
the [nix-compat] crate.