I was looking to manage my server through Cockpit project.
I would like to also be able to use cockpit-machines to manage VMs on my server. However, that module is not present in nixpkgs.
I know how to deploy simple-ish packages, however, JS based projects seem a bit complicated.
https://github.com/cockpit-project/cockpit-machines
Could you suggest a starting point with this project? Any similar modules I can refer to?
You need a Nix package first, so how I do this for NodeJS is, clone your NodeJS repo to your computer, then you will need node2nix to package it (https://github.com/svanderburg/node2nix). You can use this command inside the repo:
node2nix -18
(you need to specify -18 since by default node 14 is being used). After nix files are generated, you can test it by runningnix-build -A package
. Now that you have this done, its time to make a PR to nixpkgs and add all the new generated files along with package.json and that is your cockpit-machines package.After all this its time to integrate into existing cockpit NixOS module. I would maybe add a new option called extraPackages, like so: services.cockpit.extraPackages = [ pkgs.cockpit-machines ];. On the other hand you could just add option to the cockpit package option, like so: services.cockpit.package = pkgs.cockpit.override { enableCockpitMachines = true; };. This might be easier.
ps: I havent tested this so ask if you have any difficulties
If you haven’t read through them already:
- Nixpkgs documentation on packaging javascript things
- Nixpkgs wiki pages for Node.js and Language-specific package helpers
- Search for relevant issues and PRs: github.com/NixOS/nixpkgs/issues?q=cockpit
It looks like
cockpit
has been packaged and moduled. Maybe look atcockpit
’s package and module definitions for inspiration forcockpit-machines
? It looks likecockpit
is a hybrid python+javascript project and has been packaged primarily as a python package, andcockpit-machines
is also a hybrid python+javascript project but maybe the python aspect is less central, as I don’t see a top-levelpyproject.toml
, so you may not be able to exactly mimic thecockpit
package?