https://github.com/stefano-m/nix-stefano-m-nix-overlays

Collection of Nix overlays
https://github.com/stefano-m/nix-stefano-m-nix-overlays

nixos nixpkgs

Last synced: 2 months ago
JSON representation

Collection of Nix overlays

• Host: GitHub
• URL: https://github.com/stefano-m/nix-stefano-m-nix-overlays
• Owner: stefano-m
• License: mit
• Created: 2019-02-03T16:29:54.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-05T16:25:03.000Z (3 months ago)
• Last Synced: 2024-10-29T06:33:30.708Z (3 months ago)
• Topics: nixos, nixpkgs
• Language: Nix
• Size: 33.2 KB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Custom Nixpkgs Overlays

This is a collection of packages to add to the [Nix Packages

Collection](https://nixos.org/nixpkgs/manual/) for use with

[Nix](https://nixos.org/nix/manual/) and/or

[NixOS](https://nixos.org/nixos/manual/).

## Local Installation

1. Download or clone this repository

2. Create the folder `~/.config/nixpkgs/overlays`

3. Add a symbolic link to the created folder

Alternatively, run `install.sh` that will do the above steps for you.

Once the overlays are installed, they can be used with `nix`.

To uninstall, do the above steps backwards, or simply run the `uninstall.sh`

script.

## NixOS Installation

For NixOS to be able to see these overlays, you can use the `nixpkgs.overlays`

attribute. For example, you can fetch the git repository directly from the

network [for more information, see the official documentation about

`builtins.fetchGit`](https://nixos.org/nix/manual/#ssec-builtins).

``` nix

nixpkgs.overlays = with builtins; [

  (

    import (fetchGit {

      url = ;

      rev = ;

      ref = ;

    })

  )

];

```

### Using the overlays in NixOS with awesomewm

Most of the Lua overlays are actually useful in conjunction with the [Awesome

Window Manager](https://awesomewm.org/) which **must** be built with GTK

support.

In this case, your NixOS configuration should look something like:

``` nix

# /etc/nixos/configuration.nix

nixpkgs.overlays = with builtins; [

    (self: super: { awesome = super.awesome.override { gtk3Support = true; }; })

    (

      import (fetchGit {

        url = "https://github.com/stefano-m/nix-stefano-m-nix-overlays.git";

        rev = "0000000000000000000000000000000000000000";  # git revision heere

      })

    )

];

services.xserver.windowManager.windowManager = {

   awesome = {

     enable = true;

     luaModules = with pkgs.extraLuaPackages; [ # need overalys for this to work!

       connman_dbus

       connman_widget

       dbus_proxy

       enum

       media_player

       power_widget

       pulseaudio_dbus

       pulseaudio_widget

       upower_dbus

     ];

   };

```

## Building locally

The [`build.sh`](./build.sh) script is a simple wrapper around `nix-build` to

build the packages from the git repository. This is mostly useful for testing

new changes.

For example:

``` shell

./build.sh extraLuaPackages.connman_dbus

```