Welcome to Cachix documentation

Cachix is a service for Nix binary cache hosting.

New to Cachix? Read What is a Binary Cache? for a conceptual overview, then follow Getting Started to create and use your first cache.

Feedback can be reported via a public github issue, live chat on app.cachix.org or at support@cachix.org.

Get started

• What is a Binary Cache?
  • Without a binary cache
  • How a binary cache helps
  • The default binary cache
  • Where Cachix fits in
• Installation
  • Recommended
  • Flakes
  • Using Nixpkgs or NixOS
• Getting Started
  • Creating the cache
  • Authenticating
  • Signing key (advanced)
  • Pushing binaries with Cachix
  • Using binaries with Nix

Guides

• Pushing to Cachix
  • Pushing runtime dependencies
  • Pushing build and runtime dependencies
  • Pushing shell environment
  • Pushing whole /nix/store
  • Pushing all newly built store paths
  • Push all store paths produced during a command
  • Flakes
• Getting Started With Continuous Integration
  • GitHub Actions (recommended)
  • Buildkite
  • CircleCI
  • GitLab CI
  • Hercules CI
  • Hydra
  • Travis CI
• Pins
  • Overview
  • How to Create a Pin
  • Controlling Retention with Pins
  • Exposing Files with Artifacts
  • Examples
• Garbage Collection
  • Deletion algorithm
• Importing from S3
  • Overview
  • Prerequisites
  • Importing Cache from S3
  • Important Notes

Explanation

• Security
  • Login using GitHub
  • Secrets
  • Binary Caches

Reference

• Frequently Asked Questions
  • First step for any problem: run cachix doctor
  • What Nix versions are supported?
  • Does pushing a store path override an existing entry?
  • Are entries immediately available after they are pushed?
  • Why is Nix not picking up on any of the pre-built artifacts?
  • Is there a way to cache nix-shell?
  • How to disable binary caches when working offline?
  • What happens when I run cachix use (both immediately and any stateful effects for the future)?
  • I get InvalidPath error from Nix when invoking Cachix
  • warning: ‘https://mycache.cachix.org’ does not appear to be a binary cache
  • How can I check if my auth token works?
  • How do I supply a custom CA certificate?
• Glossary

Products

• Cachix Deploy
  • Running an agent
  • Deploying to agents
  • Troubleshooting
  • Reference
• Enterprise
  • Telemetry