NUR

The Nix User Repository (NUR) is community-driven meta repository for Nix packages. It provides access to user repositories that contain package descriptions (Nix expressions) and allows you to install packages by referencing them via attributes. In contrast to Nixpkgs, packages are built from source and are not reviewed by any Nixpkgs member.

The NUR was created to share new packages from the community in a faster and more decentralized way.

NUR automatically check its list of repositories and perform evaluation checks before it propagated the updates.

How to use

First include NUR in your packageOverrides:

To make NUR accessible for your login user, add the following to ~/.config/nixpkgs/config.nix:

{
  packageOverrides = pkgs: {
    nur = pkgs.callPackage (import (builtins.fetchGit {
      url = "https://github.com/nix-community/NUR";
    })) {};
  };
}

For NixOS add the following to your /etc/nixos/configuration.nix:

{
  nixpkgs.config.packageOverrides = pkgs: {
    nur = pkgs.callPackage (import (builtins.fetchGit {
      url = "https://github.com/nix-community/NUR";
    })) {};
  };
}

Then packages can be used or installed from the NUR namespace.

$ nix-shell -p nur.repos.mic92.inxi
nix-shell> inxi
CPU: Dual Core Intel Core i7-5600U (-MT MCP-) speed/min/max: 3061/500/3200 MHz Kernel: 4.14.51 x86_64
Up: 20h 55m Mem: 12628.4/15926.8 MiB (79.3%) HDD: 465.76 GiB (39.3% used) Procs: 409
Shell: bash 4.4.23 inxi: 3.0.10

$ nix-env -iA nur.repos.mic92.inxi

# configuration.nix
environment.systemPackages = [
  nur.repos.mic92.inxi
];

Each contributor can register their repository under a name and is responsible for its content.

NUR does not check repository for malicious content on a regular base and it is recommend to check expression before installing them.

How to add your own repository.

First create a repository that contains a default.nix in its top-level directory.

DO NOT import packages for example with import <nixpkgs> {};. Instead take all dependency you want to import from Nixpkgs by function arguments. Each repository should return a set of Nix derivations:

{ callPackage }:
{
  inxi = callPackage ./inxi {};
}

In this example inxi would be a directory containing a default.nix:

{ stdenv, fetchFromGitHub
, makeWrapper, perl
, dmidecode, file, hddtemp, nettools, iproute, lm_sensors, usbutils, kmod, xlibs
}:

let
  path = [
    dmidecode file hddtemp nettools iproute lm_sensors usbutils kmod
    xlibs.xdpyinfo xlibs.xprop xlibs.xrandr
  ];
in stdenv.mkDerivation rec {
  name = "inxi-${version}";
  version = "3.0.14-1";

  src = fetchFromGitHub {
    owner = "smxi";
    repo = "inxi";
    rev = version;
    sha256 = "0wyv8cqwy7jlv2r3j7w8ri73iywawnaihww39vlpnpjjcz1b37hw";
  };

  installPhase = ''
    install -D -m755 inxi $out/bin/inxi
    install -D inxi.1 $out/man/man1/inxi.1
    wrapProgram $out/bin/inxi \
      --prefix PATH : ${ stdenv.lib.makeBinPath path }
  '';

  buildInputs = [ perl ];
  nativeBuildInputs = [ makeWrapper ];

  meta = with stdenv.lib; {
    description = "System information tool";
    homepage = https://github.com/smxi/inxi;
    license = licenses.gpl3;
    platforms = platforms.linux;
  };
}

You can use nix-shell or nix-build to build your packages:

$ nix-shell -E 'with import <nixpkgs>{}; (callPackage ./default.nix {}).inxi'
nix-shell> inxi
nix-shell> find $buildInputs

$ nix-build -E 'with import <nixpkgs>{}; (callPackage ./default.nix {})'

Add your own repository to in the repos.json of NUR:

$ git clone https://github.com/nix-community/NUR
# open and modify repos.json in an editor

{
    "repos": {
        "mic92": {
            "url": "https://github.com/Mic92/nur-packages"
        },
        "<fill-your-repo-name>": {
            "url": "https://github.com/<your-user>/<your-repo>"
        }
    }
}

At the moment each URL must point to a git repository. By running nur/update.py the corresponding repos.json.lock is updated and the repository is tested. This will perform also an evaluation check, which must be passed for your repository. Commit the changed repos.json but NOT repos.json.lock

$ git add repos.json
$ ./nur/format_manifest.py # ensure repos.json is sorted alphabetically
$ git commit -m "add <your-repo-name> repository"
$ git push

and open a pull request towards https://github.com/nix-community/NUR.

At the moment repositories should be buildable on Nixpkgs unstable. Later we will add options to also provide branches for other Nixpkgs channels.

Use a different nix file as root expression

To use a different file instead of default.nix to load packages from, set the file option to a path relative to the repository root:

{
    "repos": {
        "mic92": {
            "url": "https://github.com/Mic92/nur-packages",
            "file": "subdirectory/default.nix"
        }
    }
}

Update NUR's lock file after updating your repository

By default we only check for repository updates once a day with an automatic cron job in travis ci to update our lock file repos.json.lock. To update NUR faster, you can use our service at https://nur-update.herokuapp.com/ after you have pushed an update to your repository, e.g.:

curl -XPOST https://nur-update.herokuapp.com/update?repo=mic92

Check out the github page for further details

Git submodules

To fetch git submodules in repositories set submodules:

{
    "repos": {
        "mic92": {
            "url": "https://github.com/Mic92/nur-packages",
            "submodules": true
        }
    }
}

Contribution guideline

When adding packages to your repository make sure they build and set meta.broken attribute to true otherwise.
Supply meta attributes as described in the Nixpkgs manual, so packages can be found by users.
Keep your repositories slim - they are downloaded by users and our evaluator and needs to be hashed.
Reuse packages from Nixpkgs when applicable, so the binary cache can be leveraged

Examples for packages that could be in NUR:

Packages that are only interesting for a small audience
Pre-releases
Old versions of packages that are no longer in Nixpkgs, but needed for legacy reason (i.e. old versions of GCC/LLVM)
Automatic generated package sets (i.e. generate packages sets from PyPi or CPAN)
Software with opinionated patches
Experiments

Why package sets instead of overlays?

To make it easier to review nix expression NUR makes it obvious where the package is coming from. If NUR would be an overlay malicious repositories could override existing packages. Also without coordination multiple overlays could easily introduce dependency cycles.

Roadmap

Implement a search to find packages
Figure out how make it working for NixOS modules

PatrickAJonas/NUR

NUR