https://github.com/jameysharp/dokku-builder-nix

Dokku plugin to build images using Nix
https://github.com/jameysharp/dokku-builder-nix

Last synced: 3 months ago
JSON representation

Dokku plugin to build images using Nix

• Host: GitHub
• URL: https://github.com/jameysharp/dokku-builder-nix
• Owner: jameysharp
• License: mit
• Created: 2021-02-04T22:27:24.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-05-29T21:23:08.000Z (over 2 years ago)
• Last Synced: 2024-11-08T15:47:30.321Z (3 months ago)
• Language: Shell
• Size: 5.86 KB
• Stars: 12
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-repos - jameysharp/dokku-builder-nix - Dokku plugin to build images using Nix (Shell)

README

        
# dokku-builder-nix

This is a plugin for [dokku][] that gives you the option of using [Nix][] to

build your app images, instead of the default Herokuish or Dockerfile builders.

[dokku]: https://dokku.com/

[Nix]: https://nixos.org/

## Requirements

- Dokku 0.24.x

- The `nix-build` binary

## Installation

```sh

# dokku 0.24.0+

$ dokku plugin:install https://github.com/jameysharp/dokku-builder-nix.git

```

## Usage

Create a `docker.nix` at the root of your app's source tree. The result of

running `nix-build` on that must be an executable which streams output

compatible with `docker load` to stdout. The Nixpkgs [dockerTools][]

`streamLayeredImage` function is the recommended way to do this: set

`config.Cmd` to a program which will listen for incoming HTTP connections on

`$PORT`.

[dockerTools]: https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-dockerTools

## Motivation

See my blog post, [Quickly building minimal Docker containers with Nix][blog],

for the rationale behind this project.

[blog]: https://jamey.thesharps.us/2021/02/03/docker-containers-nix/

## License

This plugin is derived from dokku's builder-cnb, and released under the same

MIT license as Dokku itself. See the file [LICENSE](LICENSE).