Home

Awesome

compose2nix

Test NixOS codecov Go Reference

A tool to automatically generate a NixOS config from a Docker Compose project.

Overview

Why?

Running a Docker Compose stack/project on NixOS is not well supported. One approach is to define a systemd service that runs docker-compose up on start and docker compose down on stop.

But with this approach, changes to individual services are not visible to NixOS, which means that NixOS will need to restart the systemd service on any change to the Compose file. This can be mitigated by defining a systemd reload handler, but it still is finicky to work with and will always remain opaque to NixOS.

To top it all off, using Docker Compose on NixOS is fairly redundant as the features you get with Compose are available natively on NixOS.

How?

compose2nix takes your existing Docker Compose file(s) and converts each YAML service definition into a oci-container config. The tool also sets up systemd services to create all networks and volumes that are part of the Compose project. Since compose2nix uses the same library that the Docker CLI relies on under the hood, you also get Compose file validation and syntax checking "for free".

Benefits

  1. Supports both Docker and Podman out of the box.
  2. Each Compose service maps into a systemd service that is natively managed by NixOS.
  3. A change to one container service only impacts that container and any of its dependents.
  4. Generated systemd services can be extended from your NixOS config.
  5. compose2nix supports setting additional systemd service and unit options through Docker Compose labels (search for the compose2nix.systemd. label in the samples).

Quickstart

Install the compose2nix CLI via one of the following methods:

  1. Run using nix run (recommended):

    nix run github:aksiksi/compose2nix -- -h

  2. Install from nixpkgs:

    # NixOS config
environment.systemPackages = [
  pkgs.compose2nix
];

  3. Add the following to your flake.nix:

    compose2nix.url = "github:aksiksi/compose2nix";
compose2nix.inputs.nixpkgs.follows = "nixpkgs";

    Optionally, you can pin to a specific version:

    <!-- LINT.OnChange(version) --> 
    compose2nix.url = "github:aksiksi/compose2nix/v0.2.2";
    <!-- LINT.ThenChange(flake.nix:version,main.go:version) -->

    You can then install the package by adding the following to your NixOS config:

    environment.systemPackages = [
  inputs.compose2nix.packages.x86_64-linux.default
];

Run compose2nix. Note that project must either be passed in or set in the Compose file's top-level "name".

compose2nix -project=myproject

By default, the tool looks for docker-compose.yml in the current directory and outputs the NixOS config to docker-compose.nix.

Roadmap

Docs

Sample

Working with Secrets

agenix

agenix works by decrypting secrets and placing them in /run/agenix/. To feed this into your Nix config:

  1. Place all secret env variables in the encrypted env file (e.g., my-env-file.env).

  2. Mark the decrypted env file as readable by the user running compose2nix.

  3. Run compose2nix with the env file path(s) and set -include_env_files=true:

    compose2nix --env_files=/run/agenix/my-env-file.env --include_env_files=true

[!NOTE] If you also want to ensure that you only include env files in the output Nix config, set -env_files_only=true.

Patterns

In this case, the project is called myproject and the service name is myservice. Replace podman with docker if using the Docker runtime.

List all services

sudo systemctl list-units podman-*

List all services in a project

sudo systemctl list-units *myservice*

Restart a service

Note: if the Compose service has a container_name set, then the systemd service will not include the project name.

sudo systemctl restart podman-myproject-myservice.service

Update a Container

  1. Pull the latest image for the container (requires jq):
sudo podman pull $(sudo podman inspect myproject-myservice | jq -r .[0].ImageName)
  1. Restart the service:
sudo systemctl restart podman-myproject-myservice.service

Podman: Auto-update containers

  1. Add a io.containers.autoupdate=registry label to each Compose service you want to have auto-updated.
    • Make sure to use a fully-qualified image path (e.g., docker.io/repo/image). Otherwise, Podman will fail to start the container.
  2. Run sudo podman auto-update --dry-run to see which containers would get updated. Omit --dry-run to update & restart services.

You can optionally enable a Podman-provided timer that runs the command above once per day at midnight (by default):

# Enable the existing timer unit.
systemd.timers."podman-auto-update".wantedBy = [ "timers.target" ];

See this page for details: https://docs.podman.io/en/latest/markdown/podman-auto-update.1.html

docker compose down

By default, this will only remove networks.

sudo systemctl stop podman-compose-myservice-root.target
Remove volumes

You can do one of the following:

  1. Re-generate your NixOS config with: -remove_volumes=true
  2. Run sudo podman volume prune to manually cleanup unreferenced volumes

docker compose up

sudo systemctl start podman-compose-myservice-root.target

Nvidia GPU Support

  1. Enable CDI support in your NixOS config:
{
  hardware.nvidia-container-toolkit.enable = true;
}

Docker only:

Make sure you are running Docker 25+:

{
  virtualisation.docker.package = pkgs.docker_25;
}
  1. Pass in CDI devices via either devices or deploy (both map to the same thing under the hood):
services:
  myservice:
    # ... other fields

    # Option 1
    devices:
      - nvidia.com/gpu=all
    # Option 2
    deploy:
      resources:
        reservations:
          devices:
            # Driver must be set to "cdi" - all others are ignored.
            - driver: cdi
              device_ids:
                - nvidia.com/gpu=all

    # Required for Podman.
    security_opt:
      - label=disable

NixOS Version Support Policy

I always aim to support the latest stable version of NixOS (24.05 at the time of writing). As a result, some NixOS unstable options are not used.

If the option has a strong usecase, I am open to adding a CLI flag that can be deprecated once the option is stable.

Known Issues

Docker & multiple networks

If you are using the Docker runtime and a Compose service connects to multiple networks, you'll need to use v25+. Otherwise, the container service will fail to start.

You can pin the Docker version to v25 like so:

{
  virtualisation.docker.package = pkgs.docker_25;
}

Discussion: https://github.com/aksiksi/compose2nix/issues/24

Usage

$ compose2nix -h
Usage of compose2nix:
  -auto_format
    	if true, Nix output will be formatted using "nixfmt" (must be present in $PATH).
  -auto_start
    	auto-start setting for generated service(s). this applies to all services, not just containers. (default true)
  -check_systemd_mounts
    	if set, volume paths will be checked against systemd mount paths on the current machine and marked as container dependencies.
  -create_root_target
    	if set, a root systemd target will be created, which when stopped tears down all resources. (default true)
  -default_stop_timeout duration
    	default stop timeout for generated container services. (default 1m30s)
  -env_files string
    	one or more comma-separated paths to .env file(s).
  -env_files_only
    	only use env file(s) in the NixOS container definitions.
  -generate_unused_resources
    	if set, unused resources (e.g., networks) will be generated even if no containers use them.
  -ignore_missing_env_files
    	if set, missing env files will be ignored.
  -include_env_files
    	include env files in the NixOS container definition.
  -inputs string
    	one or more comma-separated path(s) to Compose file(s). (default "docker-compose.yml")
  -output string
    	path to output Nix file. (default "docker-compose.nix")
  -project string
    	project name used as a prefix for generated resources. this overrides any top-level "name" set in the Compose file(s).
  -remove_volumes
    	if set, volumes will be removed on systemd service stop.
  -root_path string
    	root path to use for any relative paths in the Compose file (e.g., volumes). if unset, the current working directory will be used.
  -runtime string
    	one of: ["podman", "docker"]. (default "podman")
  -service_include string
    	regex pattern for services to include.
  -use_compose_log_driver
    	if set, always use the Docker Compose log driver.
  -use_upheld_by
    	if set, upheldBy will be used for service dependencies (NixOS 24.05+).
  -version
    	display version and exit
  -write_nix_setup
    	if true, Nix setup code is written to output (runtime, DNS, autoprune, etc.) (default true)

Supported Docker Compose Features

If a feature is missing, please feel free to create an issue. In theory, any Compose feature can be supported because compose2nix uses the same library as the Docker CLI under the hood.

services

Notes
image✅
container_name✅
environment✅
volumes✅
labels✅
ports✅
dns✅
cap_add/cap_drop✅
logging✅
depends_on⚠️Only short syntax is supported.
restart✅
deploy.restart_policy✅
deploy.resources.limits✅
deploy.resources.reservations.cpus✅
deploy.resources.reservations.memory✅
deploy.resources.reservations.devices⚠️Only CDI driver is supported.
devices✅
networks.aliases✅
networks.ipv*_address✅
network_mode✅
privileged✅
extra_hosts✅
sysctls✅
shm_size✅
runtime✅
security_opt✅
command✅
healthcheck✅
hostname✅
mac_address✅

networks

labels✅
name✅
driver✅
driver_opts✅
ipam✅
external✅
internal✅

volumes

driver✅
driver_opts✅
labels✅
name✅
external✅

Misc

Alternative Installation Methods

  1. Use in a Nix shell: 
    nix shell github:aksiksi/compose2nix
  2. Install the command using go: 
    go install github.com/aksiksi/compose2nix
  3. Clone this repo and run make build.