User Guide

ncps Documentation#

Welcome to the comprehensive documentation for ncps (Nix Cache Proxy Server). This documentation is organized to help you quickly find the information you need, whether you're just getting started or managing a production deployment.

Quick Navigation#

Category	What's Inside	Start Here
Getting Started	Quick start guide, core concepts, architecture overview	Quick Start
Installation	Installation guides for all deployment methods	Installation Methods
Configuration	Complete configuration reference and guides	Configuration Reference
Deployment	Single-instance and high-availability deployment	Deployment Modes
Usage	Client setup and cache management	Client Setup
Operations	Monitoring, troubleshooting, backup, upgrades	Monitoring
Architecture	System architecture and design details	Components
Developer Guide	Contributing and development guides	Contributing

Documentation by Task#

I want to...#

Get Started

• Run ncps for the first time
• Understand how ncps works
• Choose the right deployment method

Install ncps

• Install with Docker
• Install with Docker Compose
• Deploy on Kubernetes
• Use the Helm chart
• Configure on NixOS

Configure ncps

• See all configuration options
• Configure storage backends
• Choose and configure a database
• Configure analytics reporting
• Set up observability

Deploy for Production

• Deploy a single instance
• Set up high availability
• Configure distributed locking

Use ncps

• Configure Nix clients
• Manage the cache

Operate and Maintain

• Monitor ncps
• Troubleshoot issues
• Backup and restore
• Upgrade ncps

Understand Internals

• Learn about system components
• Understand storage backends
• Helm Chart Documentation - Comprehensive Helm chart reference
• Follow request flow
• Set up development environment
• See contribution guidelines

Additional Resources#

• Helm Chart Documentation - Comprehensive Helm chart reference
• See contribution guidelines - Development and contribution guidelines
• Configuration Example - Complete configuration file example
• GitHub Issues - Report bugs and request features
• Discussions - Ask questions and share ideas

Documentation Versions#

This documentation is for the latest version of ncps. For version-specific documentation, please refer to the corresponding Git tag or release branch.

Contributing to Documentation#

Found an error or want to improve the documentation? Contributions are welcome!

1. Documentation source files are in the /docs directory
2. Submit pull requests with improvements
3. Follow the existing structure and style
4. See Contributing for guidelines

---

Need Help? Check the Troubleshooting or ask in Discussions.