CID Router

---

Content address everything.

---

cid-router resolves requests for CIDs into routes for retrieval of the content and/or resources related to the content.

cid-router is not opinionated about types of CIDs, routes, or underlying protocols used by routes.

cid-router can be configured to consume routes from any number of CRPs (CID Route Provider).

Repo Organization

core	CID Router Core (Rust lib crate)
crates
api-utils	Utility library for API binaries
crps	Crates for individual CID Route Providers
iroh	Iroh CRP Crate
server	CID Router Server

Quick Start

Nix is used for managing development environments and build artifacts.

Enter development shell with all required tools:

nix develop

Makefile

There is a Makefile to make the nix-managed builds and docker exports simpler to manage. Build artifacts are placed in _build/

Build cid-router binary:

make bin.cid-router

Build cid-router docker image:

make image.cid-router`

Build all docker images:

make image.all

Build all artifacts:

make all

Justfile

Available recipes:
    ci            # Run main CI job
    readme-check  # Check auto-generated portions of README.md
    readme-update # Update auto-generated portions of README.md

Installing Nix

Install

https://nixos.org/download.html

Configure for using flakes

sudo sh -c 'echo "experimental-features = nix-command flakes" >> /etc/nix/nix.conf'