Decentralized Storage
Go to file
Mark Spanbroek 9468828a7d
increase CI timeout to 2 hours
2024-11-12 15:40:55 +01:00
.github increase CI timeout to 2 hours 2024-11-12 15:40:55 +01:00
benchmarks Pr add prover benchmark tool (#790) 2024-05-23 09:28:17 -07:00
codex use .confirm(1) instead of confirm(0) 2024-11-10 15:27:56 +01:00
docker Add ETH_PRIVATE_KEY to Docker entrypoint (#982) 2024-11-03 06:51:57 +00:00
metrics Adding metrics (#203) 2022-08-23 10:11:21 -06:00
tests fix proof integration test 2024-11-12 11:57:31 +01:00
tools/cirdl chore: update dependencies, especially nim-ethers to chronos v4 compatible version (#968) 2024-10-30 10:40:17 +00:00
vendor WIP: update polling fix from nim-ethers 2024-11-12 08:53:06 +01:00
.dockerignore Docker build (#354) 2023-03-08 12:45:55 +01:00
.editorconfig Project setup 2021-02-02 19:29:52 +01:00
.gitignore Add MIT/Apache licenses (#861) 2024-08-13 15:38:17 +00:00
.gitmodules Rework circuit downloader (#882) 2024-09-23 14:37:17 +00:00
LICENSE-APACHEv2 Remove extra license file (#876) 2024-08-19 09:48:03 +00:00
LICENSE-MIT Add MIT/Apache licenses (#861) 2024-08-13 15:38:17 +00:00
Makefile nix-flake: Add shell definition (#954) 2024-11-04 07:46:22 +00:00
README.md Remove moved docs (#930) 2024-10-03 08:55:54 +00:00
build.nims Rework circuit downloader (#882) 2024-09-23 14:37:17 +00:00
codecov.yml [ci] disable pull-request comments by codecov 2022-05-19 15:23:35 +02:00
codex.nim Rework circuit downloader (#882) 2024-09-23 14:37:17 +00:00
codex.nimble remove stale and misleading dependency version metadata (#833) 2024-06-17 14:31:10 +00:00
config.nims Chronos v4 Update (v3 Compat Mode) (#814) 2024-07-18 21:04:33 +00:00
env.sh add env.sh shim to project root (#34) 2021-12-20 13:12:18 -06:00
flake.lock nix-flake: Add shell definition (#954) 2024-11-04 07:46:22 +00:00
flake.nix nix-flake: Add shell definition (#954) 2024-11-04 07:46:22 +00:00
openapi.yaml Move the upload headers to the POST method (#978) 2024-10-29 14:40:43 +00:00

README.md

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.