NGIpkgs

NGIpkgs is a collection of Nix packages and services for software projects that are supported through the Next Generation Internet (NGI) initiative of the European Commission.

Structure of NGIpkgs

The software in NGIpkgs can be divided into two broad categories: Nix packages, and NixOS modules.

Nix packages can theoretically be built and run on any operating system that runs the Nix package manager. The output of building a Nix package is often a usable library or executable and most if not all of its dependencies. In NGIpkgs, these packages are all contained in the pkgs directory. For simple package definitions, we use pkgs/by-name/<pname>/package.nix, inspired by Nix RFC 140. Otherwise, packages are added in pkgs/<pname>/default.nix imported in pkgs/default.nix.

NixOS modules are components that can be easily integrated into NixOS. Usually they enrich Nix packages with configuration parameters. Many of them represent services that map to one or more systemd service(s) that are designed to, run persistently on NixOS. These modules are defined in the modules directory of NGIpkgs, and they are ready to be deployed to a new NixOS system (such as a container, VM, or physical machine). Templates in configs are a good starting point for anyone interested in using modules, and they are also used for testing.

.
├── flake.nix
├── pkgs
│   ├── by-name
│   │   └── ...           # directories of packages that are added `by-name`
│   ├── default.nix       # imports all packages that are not in `by-name`
│   └── ...               # directories for packages
├── modules
│   └── ...                       # add module files here  
├── README.md                     # this file
├── configs
│   ├── all-configurations.nix    # import configuration files here
│   └── ...                       # add configuration directories here
└── ...

Continuous Builds of Packages with Hydra

All packages in the main branch of NGIpkgs are automatically built by a Hydra server. The results of these builds can be seen at https://hydra.ngi0.nixos.org/jobset/NGIpkgs/main#tabs-jobs

Reasoning for Creation of the NGIpkgs Monorepo

• The user can discover NGI projects through a unified webpage and expectation is set that many of them are research projects.
• The developers get a unified code structure, CI & CD tooling, and a common PR and issue tracker which facilitates reviews.
• The funding organizations get an easy overview of the packaging situation.

Contributing to NGIpkgs

Please see CONTRIBUTING.md