cratery
A lightweight private cargo registry with batteries included, built for organizations, featuring docs generation and dependency analysis.
What is cratery?
Cratery is a private Cargo registry built for organizations to host and manage their internal Rust crates securely. It solves the problem of needing a private, self-hosted alternative to crates.io for proprietary code, offering built-in features like documentation generation and dependency analysis. The project provides a complete ecosystem for internal crate management, including authentication, administration, and statistics tracking.
Organizations and teams developing proprietary Rust software who need a secure, private registry for internal crate hosting and management. It's also suitable for developers requiring advanced features like automated documentation generation and dependency vulnerability scanning.
Developers choose Cratery because it's a lightweight, all-in-one private registry with essential features like docs.rs-style documentation generation and deps.rs-style dependency analysis built-in. Its self-hosted nature offers full control and security, while support for Docker and flexible storage options (filesystem or S3) simplifies deployment and scaling.
Overview
Cratery is a private Cargo registry designed for organizations that need to host and manage their internal Rust crates. It provides a secure, self-contained solution with essential features like documentation generation and dependency analysis out of the box, eliminating the need to rely on public infrastructure for proprietary code.
Key Features
- Private Cargo Registry — Host and manage internal Rust crates with authentication and access control.
- Automatic Documentation Generation — Generates and serves documentation for published crates, similar to docs.rs, with support for worker nodes and target-specific builds.
- Dependency Analysis — Scans dependency graphs to detect outdated dependencies and vulnerabilities from RustSec, with email notifications for owners.
- Administration Panel — Manage crate owners and permissions through a web interface.
- Download Statistics — Tracks and displays usage statistics for hosted crates.
- Flexible Storage — Supports local filesystem or S3 for storing crates, metadata, and generated documentation.
- Index Protocols — Supports both legacy git and modern sparse protocols for registry access.
Philosophy
Cratery is built to be a comprehensive, 'batteries-included' solution that prioritizes security and ease of use for organizations, providing all the essential tools for managing a private Rust ecosystem in one package.
Use Cases
Best For
- Organizations needing a private registry for proprietary Rust crates
- Teams requiring automated documentation generation for internal libraries
- Projects that need dependency vulnerability scanning and outdated dependency detection
- Companies wanting download statistics and usage analytics for internal crates
- Environments requiring OAuth authentication for registry access
- Infrastructure needing scalable storage with S3 integration for crate artifacts
Not Ideal For
- Teams without an existing OAuth identity provider for user authentication
- Projects requiring only basic crate hosting without integrated documentation or dependency analysis
- Environments preferring managed registry services over self-hosted solutions
Pros & Cons
Pros
Includes automatic documentation generation similar to docs.rs, dependency vulnerability scanning from RustSec, and download statistics, all out of the box as highlighted in the README.
Supports both local filesystem and S3 storage, with options for worker nodes to distribute documentation generation tasks, enabling scalable deployments.
Compatible with both legacy git and new sparse Cargo registry protocols, ensuring future-proof access and alignment with Cargo's evolution.
Built-in OAuth integration for secure access control, configurable with organizational identity providers, though default Google setup is for demo only.
Cons
Requires managing numerous environment variables for authentication, storage, and features, as shown in the lengthy configuration section, which can be overwhelming for initial setup.
Dependency analysis relies on external sources like crates.io and RustSec, adding points of failure and potential setup hurdles if those services are unavailable.
Features like email notifications and worker nodes require additional configuration (e.g., SMTP, master-worker setup), increasing deployment complexity beyond basic registry needs.
Frequently Asked Questions
Related Projects
chartered✈️ a private, authenticated, permissioned cargo registry
CratesThe official public registry for Rust/Cargo
RepoFlowSimple and fast platform for hosting private Composer registries. Also supports Docker, npm, PyPI, Maven, and RubyGems. Offers free options for both cloud and self-hosted setups
CloudsmithA fully managed package management SaaS, with first-class support for public and private Cargo/Rust registries (plus many others). Has a generous free-tier and is also completely free for open-source
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.