Skip to content

Commit

Permalink
docs: add guidance on selecting Nix packages for builds
Browse files Browse the repository at this point in the history
Generated-by: aiautocommit
  • Loading branch information
iloveitaly committed Jan 21, 2025
1 parent 81aae5b commit e34610e
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/pages/docs/guides/configuring-builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ provider (e.g. Node, Cargo, Python) will also installed.

It is recommended to install packages from Nix rather than Apt if they are available. You can search for Nix packages [here](https://search.nixos.org/packages?channel=unstable).

It's common for these to be many packages with a similar name and it can be hard to determine which one to pick. Here are some tips:

* If your application is shelling out to a command (i.e. your application expects a specific binary to be available on `$PATH`) look for a package that the binary you need in the `Programs provided` and add it as a `nixPkgs` entry.
* If your application needs a shared library, look for a package that contains a `dev` output. You can target just that `dev` (shared library) output by adding the suffix `.dev` to the `nixLibs` definition.

## Custom build command

You can override the build command with
Expand Down

0 comments on commit e34610e

Please sign in to comment.