README.md

cardano.nix

Collection of Cardano related Nix packages and NixOS modules, with a special focus on:

• auto-generated documentation
• virtual machine based integration tests
• easy to use module interface

Example:

{
  cardano = {
    network = "preview";
    node.enable = true;
    ogmios.enable = true;
  };
}

This NixOS configuration will start cardano-node and ogmios on the preview network.

Read the Documentation

Quick start

Install nix with flakes. Run a virtual machine with cardano-node and ogmios:

nix run github:mlabs-haskell/cardano.nix#vm-preview

Ogmios will be available at http://localhost:1337

Read the Documentation on how to get started and deploy cardano services on virtual or cloud machines.

Developing cardano.nix

See the development documentation on how to set up binary caches to speed up builds, start the development shell, and run virtual machine network integration tests.

License information

cardano.nix released under terms of Apache-2.0 license.