Docker

Docker is a utility to pack, ship and run any application as a lightweight container.

Installation

Inside your configuration.nix:

virtualisation.docker.enable = true;

More options are available.

Adding users to the docker group will provide them access to the socket:

Warning: Beware that the docker group membership is effectively equivalent to being root!

users.users.<myuser>.extraGroups = [ "docker" ];

Note: In the btrfs filesystem you might need to set the storageDriver option, like so virtualisation.docker.storageDriver = "btrfs"

Building a docker image with nixpkgs

There is an entry for dockerTools in the nixpkgs manual for reference. In the nixpkgs repo some examples can be found.

Also check out the excellent article by lethalman about building minimal docker images with nix.

Reproducible image dates

The manual advises against using created = "now", as that prevents images from being reproducible.

An alternative, if using flakes, is to do created = builtins.substring 0 8 self.lastModifiedDate, which uses the commit date, and is therefore reproducible.

How to calculate the sha256 of a pulled image

The sha256 argument of the dockerTools.pullImage function is the checksum of the archive generated by Skopeo. Since the archive contains the name and the tag of the image, Skopeo arguments used to fetch the image have to be identical to those used by the dockerTools.pullImage function.

For instance, the sha of the following image

pkgs.dockerTools.pullImage{
  imageName = "lnl7/nix";
  finalImageTag = "2.0";
  imageDigest = "sha256:632268d5fd9ca87169c65353db99be8b4e2eb41833b626e09688f484222e860f";
  sha256 = "1x00ks05cz89k3wc460i03iyyjr7wlr28krk7znavfy2qx5a0hfd";
};

can be manually generated with the following shell commands

skopeo copy docker://lnl7/nix@sha256:632268d5fd9ca87169c65353db99be8b4e2eb41833b626e09688f484222e860f docker-archive:///tmp/image.tgz:lnl7/nix:2.0

nix-hash --base32 --flat --type sha256 /tmp/image.tgz

1x00ks05cz89k3wc460i03iyyjr7wlr28krk7znavfy2qx5a0hfd

Container images with nix

While dockerTools allows to build lightweight containers, it requires nix to be installed on the host system. An alternative are docker images with nix preinstalled:

• nixos/nix (official)
• nixpkgs/nix (built from https://github.com/nix-community/docker-nixpkgs)

Docker Compose with Nix

Arion is created for running Nix-based projects in Docker Compose. It uses the NixOS module system for configuration, it can bypass docker build and lets you use dockerTools or use the store directly in the containers. The images/containers can be typical dockerTools style images or full NixOS configs.

To use Arion, you first need to add its module to you NixOS configuration:

 modules = [ arion.nixosModules.arion ];

After that you can access its options under

 virtualisation.arion = {}

A config for a simple container could look like this:

 virtualisation.arion = {
   backend = "docker";
   projects = {
     "db" = settings.services."db".service = {
       image = "";
       restart = "unless-stopped";
       environment = { POSTGRESS_PASSWORD = "password"; };
     };
   };
 };

See also

Workgroup:Container

As of 22.05 rootless docker is available. Alternatively you can use Podman.