README.md

Discord Overlay

---

Caution

This overlay is deprecated now that NixOS/nixpkgs#197248 has been merged.

This overlay is no longer actively maintained and might stop working in the future. It has been left up becuse it might still be useful in certain situations, but you should be careful with how you use it.

---

This is a Nixpkgs overlay that provides the latest¹ versions of the Discord desktop apps. You can use it with or without flakes:

With flakes (preferred)

To run it once:

$ nix run github:InternetUnexplorer/discord-overlay#discord-canary --update-input nixpkgs --no-write-lock-file

To add it to your NixOS configuration:

# /etc/nixos/flake.nix
# Your configuration will probably look different; this is just an example!
{
  description = "Example NixOS configuration";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    discord-overlay.url = "github:InternetUnexplorer/discord-overlay";
    discord-overlay.inputs.nixpkgs.follows = "nixpkgs";
  };

  outputs = { self, nixpkgs, discord-overlay }: {
    nixosConfigurations.example = nixpkgs.lib.nixosSystem {
      system = "x86_64-linux";
      modules = [
        ({ ... }: { nixpkgs.overlays = [ discord-overlay.overlays.default ]; })
        ./configuration.nix
      ];
    };
  };
}

Without flakes (not recommended)

To use it with nix-env:

# ~/.config/nixpkgs/overlays.nix
[
  (import (builtins.fetchTarball {
    url = "https://github.com/InternetUnexplorer/discord-overlay/archive/main.tar.gz";
  }))
  # ...
]

To add it to your NixOS configuration:

# /etc/nixos/configuration.nix
{ config, pkgs, lib, ... }:

{
  nixpkgs.overlays = [
    (import (builtins.fetchTarball {
      url = "https://github.com/InternetUnexplorer/discord-overlay/archive/main.tar.gz";
    }))
  ];
  # ...
}

You can find an explanation of how the update process works here. The old README is available here. Licensed under the Unlicense.

Footnotes

1. Checking for updates happens every 30 minutes. ↩