Skip to content

codex-storage/nim-codex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a9e55e6 · Jan 15, 2025
Jan 13, 2025
May 23, 2024
Jan 15, 2025
Jan 9, 2025
Aug 23, 2022
Jan 14, 2025
Jan 10, 2025
Oct 30, 2024
Jan 10, 2025
Mar 8, 2023
Feb 2, 2021
Aug 13, 2024
Sep 23, 2024
Aug 19, 2024
Aug 13, 2024
Jan 10, 2025
Oct 3, 2024
Jan 9, 2025
May 19, 2022
Jan 10, 2025
Jun 17, 2024
Jan 10, 2025
Dec 20, 2021
Jan 10, 2025
Jan 10, 2025
Jan 8, 2025

Repository files navigation

Codex Decentralized Durability Engine

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.

License: Apache License: MIT Stability: experimental CI Docker Codecov Discord Docker Pulls

Build and Run

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

Configuration

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.

Guides

To get acquainted with Codex, consider:

API

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.