rhi/peerix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add readme

Browse source
This commit is contained in:
Sarah 2021-10-17 15:56:46 +02:00
parent c2a5613e4f
commit 0f6340de13
No known key found for this signature in database
GPG key ID: 708F7ACE058F0186
1 changed files with 33 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md Normal file
View file

@ -0,0 +1,33 @@
Peerix
======
Peerix is a peer-to-peer binary cache for nix derivations.
Every participating node can pull derivations from each other instances' respective nix-stores.
How does it work?
-----------------
Peerix implements a nix binary cache. When the nix package manager queries peerix, peerix
will ask the network if any other peerix instances hold the package, and if some other instance
holds the derivation, it will download the derivation from that instance.
Installation
------------
There is a nix-module located at `module.nix` that configures your nixos-installation
to automatically use peernix.
These Options exist:
+----------------------------------+----------------------------------------------------------------------------------------------+
| Option | Description |
+----------------------------------+----------------------------------------------------------------------------------------------+
| `services.peerix.enable` | Enables Peerix |
| `services.peerix.openFirewall` | Open the neccessary firewall ports. |
| `services.peerix.user` | What user should the peerix service run under. |
| `services.peerix.group` | What group should the peerix service run under. |
| `services.peerix.privateKeyFile` | A path to the file that contains the path to the private key to sign your derivations. |
| `services.peerix.publicKeyFile` | A path to the file that contains the path to the public key so nix can verify the signature. |
+----------------------------------+----------------------------------------------------------------------------------------------+
To sign the peerix cache, you can use `nix-store --generate-binary-cache-key` to create keys to verify authenticity of
the packages in each nix-store.