Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngi-nix/ngipkgs
Nix packages and services for projects supported through the NGI program
https://github.com/ngi-nix/ngipkgs
build-with-buildbot ngi nix nixos nlnet
Last synced: 3 days ago
JSON representation
Nix packages and services for projects supported through the NGI program
- Host: GitHub
- URL: https://github.com/ngi-nix/ngipkgs
- Owner: ngi-nix
- License: mit
- Created: 2023-02-14T11:21:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-18T17:00:28.000Z (6 months ago)
- Last Synced: 2024-05-19T14:05:17.746Z (6 months ago)
- Topics: build-with-buildbot, ngi, nix, nixos, nlnet
- Language: Nix
- Homepage: https://nlnet.nl/project/current.html
- Size: 4.51 MB
- Stars: 24
- Watchers: 14
- Forks: 14
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# NGIpkgs
[Nix] is an open source build system, configuration management system, and mechanism for deploying software, focused on reproducibility.
It is the basis of an ecosystem of exceptionally powerful tools.
Nixpkgs is [the largest, most up-to-date software repository in the world][repology].
NixOS is a Linux distribution that can be configured fully declaratively, with unmatched flexibility.
Many software projects funded by the [Next Generation Internet] (NGI) initiative of the European Commission through the [NLnet Foundation] are not mature enough to distribute through Nixpkgs, or cannot be included in Nixpkgs for technical reasons.
This repository makes such projects available as
- Package recipes compatible with [Nixpkgs]
- Configuration modules compatible with [NixOS]
and provides automatically tested example NixOS configurations.
NGIpkgs was created as part of [Summer of Nix], organised by the [NixOS Foundation].
[Nix]: https://github.com/NixOS/nix
[repology]: https://repology.org/repositories/graphs
[Nixpkgs]: https://github.com/nixos/nixpkgs
[NixOS]: https://nixos.org/manual/nixos
[Next Generation Internet]: https://www.ngi.eu
[NLnet Foundation]: https://nlnet.nl
[Summer of Nix]: https://github.com/ngi-nix/summer-of-nix
[NixOS Foundation]: https://nixos.org/community/#foundation
# How to use software from NGIpkgs
This is what you can do with software from NGIpkgs:
- Run **standalone programs** locally with Nix
- Use **libraries or tools** to build software with Nixpkgs
- Deploy **services** to machines running NixOS
In order to do that:
- [Install Nix on Linux or WSL](https://nix.dev/install-nix)
- [Enable the flakes experimental feature](https://wiki.nixos.org/wiki/Flakes)
It will help you to go more quickly if you learn to:
- [Read the Nix language](https://nix.dev/tutorials/nix-language)
- [Package existing software with Nixpkgs](https://nix.dev/tutorials/packaging-existing-software)
- [Work with NixOS modules](https://nix.dev/tutorials/module-system/)
- [Run NixOS in virtual machines](https://nix.dev/tutorials/nixos/nixos-configuration-on-vm)
- [Provision remote NixOS machines via SSH](https://nix.dev/tutorials/nixos/provisioning-remote-machines)
- [Set up your own cache for sharing binaries](https://nix.dev/tutorials/nixos/binary-cache-setup)
## Structure of NGIpkgs
The software in NGIpkgs can be divided into two broad categories: Nix packages, and NixOS modules.
```
.
├── flake.nix
├── pkgs
│ └── by-name
│ └── … # directories of packages
├── projects
│ ├── # names matching those at https://nlnet.nl/project
│ │ ├── default.nix # project definition
│ │ └── … # files of the project (e.g. NixOS module, configuration, tests, etc.)
│ └── default.nix # imports all projects
├── README.md # this file
└── …
```
Nix packages can theoretically be built and run on any operating system that runs Nix.
The output of building a Nix package is often a library or executable, including its dependencies.
In NGIpkgs, these packages are all contained in [the `pkgs` directory](./pkgs).
For simple package definitions, we use `pkgs/by-name//package.nix`, inspired by [Nix RFC 140].
[Nix RFC 140]: https://github.com/NixOS/rfcs/blob/c8569f6719356009204133cd00d92010889ed56d/rfcs/0140-simple-package-paths.md
Corresponding to [projects funded by NGI through NLnet](https://nlnet.nl/project/) there are per-project subdirectories within [the `projects` directory](./projects).
These per-project directories contain a `default.nix` which
- Picks packages associated with the project from those defined in `pkgs` and Nixpkgs,
- Exposes NixOS modules, tests, and configurations which are also contained in the per-project directory,
- May contain additional metadata about the project.
NixOS modules are components that can be easily integrated into a NixOS configuration.
Many of them represent services that map to one or more systemd services that are designed to run on NixOS.
These modules are ready to be deployed to a NixOS system, such as a container, virtual machine, or physical machine.
Example configurations found in the corresponding per-project directory are a good starting point for anyone interested in using these modules, and are sure to work because they are also used for testing.
## Continuous builds of packages with Buildbot
All packages in the [main branch of NGIpkgs](https://github.com/ngi-nix/ngipkgs/tree/main) are automatically built by a [Buildbot](https://github.com/buildbot/buildbot) server.
The results of these builds can be found at
## Reasoning for creation of the NGIpkgs monorepo
- Users can discover NGI projects on an [overview page](https://ngi-nix.github.io/ngipkgs/) and use them immediately.
- Many software packages are research projects that would not make sense to distribute through Nixpkgs.
- The developers get a unified code structure, CI & CD tooling, and a common pull request and issue tracker which facilitates reviews.
- The funding organizations get an overview of the packaging situation.
## Contributing to NGIpkgs
Please see [`CONTRIBUTING.md`](CONTRIBUTING.md)