The Codex project aims to create a decentralized durability engine that allows persisting data in p2p networks. In other words, it allows storing files and data with predictable durability guarantees for later retrieval.

WARNING: This project is under active development and is considered pre-alpha.

For detailed instructions on preparing to build nim-codex see Build Codex.

To build the project, clone it and run:

make update && make

The executable will be placed under the build directory under the project root.

Run the client with:

build/codex

It is possible to configure a Codex node in several ways:

1. CLI options
2. Environment variables
3. Configuration file

The order of priority is the same as above: CLI options --> Environment variables --> Configuration file.

Please check documentation for more information.

To get acquainted with Codex, consider:

• running the simple Codex Two-Client Test for a start, and;
• if you are feeling more adventurous, try Running a Local Codex Network with Marketplace Support using a local blockchain as well.

The client exposes a REST API that can be used to interact with the clients. Overview of the API can be found on api.codex.storage.