Toggle navigation

.md .pdf

repository open issue suggest edit

Welcome to nix.dev testing

Introduction

The Nix ecosystem is a DevOps toolkit to achieve:

• Reproducible development environments.

• Easy installation of software over URLs.

• Easy transfer of software environments between computers.

• Declarative specification of Linux machines.

• Reproducible integration testing using virtual machines.

• Avoidance of version conflicts with already installed software.

• Installing software from source code.

• Transparent build caching using binary caches.

• Strong support for software auditability.

• First-class cross compilation support.

• Remote builds.

• Remote deployments.

• Atomic upgrades and rollbacks.

This documentation supplements the official Nix, NixOS, Nixpkgs and NixOps manuals.

• Tutorials
  • Install Nix
    • Verify installation
  • Ad hoc developer environments
    • What is a shell environment?
    • When are shell environments useful?
    • Searching package attribute names
    • Ad hoc shell environments
    • Beyond tooling: Python libraries
    • Towards reproducibility
    • References
    • Next steps
  • Reproducible interpreted scripts
    • Requirements
    • A trivial script with non-trivial dependencies
    • The script
    • Next steps
  • Nix language basics
    • Overview
    • Reading the Nix language without fear
    • Names and values
    • Functions
    • Function libraries
    • Impurities
    • Derivations
    • Worked examples
    • References
    • Next steps
  • Towards reproducibility: pinning Nixpkgs
    • Pinning packages with URLs inside a Nix expression
    • Dependency management with niv
    • Next steps
  • Declarative and reproducible developer environments
    • When are declarative shell environments useful?
    • Getting started
    • Customizing your developer environment
    • direnv: Automatically activating the environment on directory change
    • Next steps
  • Continuous Integration with GitHub Actions
    • Caching builds using Cachix
    • Setting up GitHub Actions
    • Next steps
  • Set up a development environment
  • Building and running Docker images
    • Prerequisites
    • Build your first container
    • Run the container
    • Working with Docker images
    • Next steps
  • Building a bootable ISO image
    • Next steps
  • Deploying NixOS using Terraform
    • Booting NixOS image
    • Deploying NixOS changes
    • Caveats
    • Next steps
  • Installing NixOS on a Raspberry Pi
    • Booting NixOS live image
    • Getting internet connection
    • Updating firmware
    • Installing NixOS
    • Making changes
    • Next steps
  • NixOS virtual machines
    • What will you learn?
    • What do you need?
    • Starting from the default NixOS configuration
    • Creating a QEMU based virtual machine using a configuration
    • Running the virtual machine
  • References
  • Integration testing using virtual machines (VMs)
    • Testing a typical web application backed by PostgreSQL
    • Writing the test
    • Running tests
    • Developing and debugging tests
    • Next steps
  • Cross compilation
    • What’s a target platform?
    • Pinning Nixpkgs
    • Determining the host platform config
    • Choosing the host platform with Nix
    • Specifying the host platform
    • Cross compiling for the first time
    • Real-world cross compiling of a Hello World example
    • Developer environment with a cross compiler
    • Next steps
• Templates
  • Getting started Nix template
• Anti-patterns
  • In the Nix language
    • Unquoted URLs
    • rec { ... } expression
    • with attrset; ... expression
    • <...> search path
    • attr1 // attr2 merge operator
    • Reproducibility referencing top-level directory with ./.
• Reference
  • Pinning Nixpkgs
    • Possible URL values
    • Examples
• Frequently Asked Questions
  • Nix
    • What to do if a binary cache is down or unreachable?
    • How do I add a new binary cache?
    • How do I force nix to re-check whether something exists at a binary cache?
    • How do I fix: error: querying path in database: database disk image is malformed
    • How to operate between Nix paths and strings?
    • How do I fix: error: current Nix store schema is version 10, but I only support 7
    • How to build reverse dependencies of a package?
    • I’m getting: writing to file: Connection reset by peer
    • What are channels and different branches on github?
    • How can I manage dotfiles in $HOME with Nix?
    • Are there some known impurities in builds?
    • What’s the recommended process for building custom packages?
  • NixOS
    • How to build my own ISO?
    • How do I connect to any of the machines in NixOS tests?
    • How to bootstrap NixOS inside an existing Linux installation?
• Recommended reading
  • Nix language tutorials
  • Other Articles
  • Other videos
• Software Nix has influenced
• Glossary
• How to Contribute
  • Report an issue
  • Contribute to Nix
  • Contribute to Nixpkgs
  • Contribute to NixOS

next

Tutorials