Arion options

Attribute set that will be turned into the x-arion section of the docker-compose.yaml file.

Attribute set that will be turned into the docker-compose.yaml file, using Nix’s toJSON builtin.

Prefixes store paths on the host, allowing the Nix store to be stored at an alternate location without altering the format of store paths.

For example: instead of mounting the host’s /nix/store as the container’s /nix/store, this will mount /mnt/foo/nix/store as the container’s /nix/store.

The numeric user id (UID) of the user running arion.

This lets you to write modules that interact with the host user’s files, which is helpful for local development, but not intended for production-like deployment scenarios.

A derivation that produces a docker-compose.yaml file for this composition.

The text of out.dockerComposeYaml.

The text of out.dockerComposeYaml.

Name of the project.

See COMPOSE_PROJECT_NAME

An attribute set of service configurations. A service specifies how to run an image as a container.

The composition configuration.

The composition-level host option values.

Top level paths in the container.

Add the /bin/sh and /usr/bin/env symlinks and some lightweight files.

A human readable name for the docker image.

Shows up in the docker ps output in the IMAGE column, among other places.

Whether to build this image with Nixpkgs' dockerTools.buildLayeredImage and then load it with docker load.

By default, an image will be built with Nix unless service.image is set. See also image.name, which defaults to the service name.

This is a low-level fallback for when a container option has not been modeled in the Arion module system.

This attribute set does not have an appropriate merge function. Please use the specific image options instead.

Run-time configuration of the container. A full list of the options is available in the Docker Image Specification v1.2.0.

NixOS build products from config.system.build, such as toplevel and etc.

This option is unused by default, because not all images use NixOS.

One way to use this is to enable nixos.useSystemd, but the NixOS configuration can be used in other ways.

Modules to add to the NixOS configuration.

This option is unused by default, because not all images use NixOS.

One way to use this is to enable nixos.useSystemd, but the NixOS configuration can be used in other ways.

Evaluated NixOS configuration, to be read by service-level modules.

This option is unused by default, because not all images use NixOS.

One way to use this is to enable nixos.useSystemd, but the NixOS configuration can be used in other ways.

When enabled, call the NixOS systemd-based init system.

Configure NixOS with the nixos.configuration option.

Information about a service to include in the Docker Compose file, but that will not be used by the docker-compose> command itself.

It will be inserted in x-arion.serviceInfo.<service.name>.

Raw input for the service in docker-compose.yaml.

You should not need to use this option. If anything is missing, please contribute the missing option.

This option is user accessible because it may serve as an escape hatch for some.

Locates a Dockerfile to use for creating an image to use in this service.

See Docker Compose#context

Enable/disable linux capabilities, or pick Docker’s default.

Setting a capability to true means that it will be "added". Setting it to false means that it will be "dropped". See Docker Compose#cap_add-cap_drop

Omitted and null capabilities will therefore be set according to Docker’s default list of capabilities.

See Docker Compose#command

See Docker Compose#container_name

Container program and arguments to invoke when calling arion exec <service.name> without further arguments.

See Docker Compose#depends_on

See docker run --device documentation

See Docker Compose#devices

See Docker Compose#dns

See Docker Compose#entrypoint

See Docker Compose#env_file

See Docker Compose#environment

See Docker Compose#expose

See Docker Compose#external_links

See Docker Compose#extra_hosts

Adds a ':ro' (read-only) access mode to the host nix store bind mount.

Analogous to the docker run counterpart.

See Docker Compose#domainname-hostname-ipc-mac_address-privileged-read_only-shm_size-stdin_open-tty-user-working_dir

See Docker Compose#image

See Docker Compose#labels

See Docker Compose#links

The name of the service - <name> in the composition-level services.<name>

See Docker Compose#network_mode

See Docker Compose#networks

Expose ports on host. "host:container" or structured.

See Docker Compose#ports

Analogous to the docker run counterpart.

See Docker Compose#domainname-hostname-ipc-mac_address-privileged-read_only-shm_size-stdin_open-tty-user-working_dir

See Docker Compose#restart

See Docker Compose#stop_signal

See Docker Compose#sysctls

See Docker Compose#tmpfs

Analogous to the docker run counterpart.

See Docker Compose#domainname-hostname-ipc-mac_address-privileged-read_only-shm_size-stdin_open-tty-user-working_dir

Make the host Nix daemon available.

Bind mounts the host store if enabled, avoiding copying.

Analogous to the docker run counterpart.

See Docker Compose#domainname-hostname-ipc-mac_address-privileged-read_only-shm_size-stdin_open-tty-user-working_dir

See Docker Compose#volumes

Analogous to the docker run counterpart.

See Docker Compose#domainname-hostname-ipc-mac_address-privileged-read_only-shm_size-stdin_open-tty-user-working_dir