README.md

Linux packaging (Nix / NixOS)

This directory holds the Nix packaging for ZenNotes.

Test it before installing

You can use nix run to run the application without installing it:

For the desktop app:

nix run github:ZenNotes/zennotes

For the server:

nix run github:ZenNotes/zennotes#zennotes-server

Installing on NixOS

For now as the package is not in the official nixpkgs repo you will need to add an input in your flake.nix, like this:

inputs = {
  # ...

  zennotes.url = "github:ZenNotes/zennotes";
};

outputs = { nixpkgs, ... } @ inputs:
{
  # ...
};

And then you can add it to your system packages:

{ pkgs, inputs, ... }:

{
  environment.systemPackages = [
    inputs.zennotes.packages.${pkgs.system}.zennotes-desktop
    inputs.zennotes.packages.${pkgs.system}.zennotes-server
  ];
}

If you don't use flakes you'll need to copy the package-desktop.nix file into your NixOS configuration and add it to your system packages:

environment.systemPackages = [
  (pkgs.callPackage ./package-desktop.nix { })
];

Same goes for the server package:

environment.systemPackages = [
  (pkgs.callPackage ./package-server.nix { })
];

Updating to a new release

1. Open release-data.json
2. Bump version:

{
  "version": "2.3.0", // => 2.4.0
  // ...
}

2. Update the source hash To obtain a new hash (replace X.X.X with the desired version):

nix-prefetch-github ZenNotes zennotes --rev "vX.X.X"

{
  // ...
  "hash": "sha256-+tLPVnnMbtMa5blSwHav9ZMlnkUsrdG62mMGxhbmy6g=", // update to new hash
  // ...
}

3. Update the npmDepsHash (if needed) and vendorHash (if needed) To obtain a new npmDepsHash use this command in an updated project root:

prefetch-npm-deps package-lock.json

{
  // ...
  "npmDepsHash": "sha256-7IpGnxVjaJvfSZyKjOylGMhFqa1bx8Ry5O1yqYfNnCE=",
  "vendorHash": "sha256-wYBF7CjM6AvoWMWql9hFmIaj6pCmli4vOef6POyGkfU="
}

4. Build and test

nix build
./result/bin/zennotes-desktop

nix build .#server
./result/bin/zennotes-server

Notes & limitations

• Automatic updates inside ZenNotes are disabled because Nix packages are immutable.
• Updates should be performed through Nix by updating the package definition.