Skip to content

Commit b491906

Browse files
Remove moved docs (#930)
* Remove moved document * Update main Readme and point links to the documentation site
1 parent 5ace105 commit b491906

File tree

3 files changed

+10
-383
lines changed

3 files changed

+10
-383
lines changed

README.md

Lines changed: 10 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Codex Decentralized Durability Engine
22

3-
> The Codex project aims to create a decentralized durability engine that
4-
> allows persisting data in p2p networks. In other words, it allows storing
5-
> files and data with predictable durability guarantees for later retrieval.
3+
> 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.
64
75
> WARNING: This project is under active development and is considered pre-alpha.
86
@@ -26,8 +24,7 @@ To build the project, clone it and run:
2624
make update && make
2725
```
2826

29-
The executable will be placed under the `build` directory under the project
30-
root.
27+
The executable will be placed under the `build` directory under the project root.
3128

3229
Run the client with:
3330

@@ -38,145 +35,19 @@ build/codex
3835

3936
It is possible to configure a Codex node in several ways:
4037
1. CLI options
41-
2. Env. variable
42-
3. Config
38+
2. Environment variables
39+
3. Configuration file
4340

44-
The order of priority is the same as above:
45-
Cli arguments > Env variables > Config file values.
41+
The order of priority is the same as above: CLI options --> Environment variables --> Configuration file.
4642

47-
### Environment variables
43+
Please check [documentation](https://docs.codex.storage/learn/run#configuration) for more information.
4844

49-
In order to set a configuration option using environment variables,
50-
first find the desired CLI option and then transform it in the following way:
51-
52-
1. prepend it with `CODEX_`
53-
2. make it uppercase
54-
3. replace `-` with `_`
55-
56-
For example, to configure `--log-level`, use `CODEX_LOG_LEVEL` as the
57-
environment variable name.
58-
59-
### Configuration file
60-
61-
A [TOML](https://toml.io/en/) configuration file can also be used to set
62-
configuration values. Configuration option names and corresponding values are
63-
placed in the file, separated by `=`. Configuration option names can be
64-
obtained from the `codex --help` command, and should not include
65-
the `--` prefix. For example, a node's log level (`--log-level`) can be
66-
configured using TOML as follows:
67-
68-
```toml
69-
log-level = "trace"
70-
```
71-
72-
The Codex node can then read the configuration from this file using
73-
the `--config-file` CLI parameter, like
74-
`codex --config-file=/path/to/your/config.toml`.
75-
76-
### CLI Options
77-
78-
```
79-
$ build/codex --help
80-
Usage:
81-
82-
codex [OPTIONS]... command
83-
84-
The following options are available:
85-
86-
--config-file Loads the configuration from a TOML file [=none].
87-
--log-level Sets the log level [=info].
88-
--metrics Enable the metrics server [=false].
89-
--metrics-address Listening address of the metrics server [=127.0.0.1].
90-
--metrics-port Listening HTTP port of the metrics server [=8008].
91-
-d, --data-dir The directory where codex will store configuration and data.
92-
-i, --listen-addrs Multi Addresses to listen on [=/ip4/0.0.0.0/tcp/0].
93-
-a, --nat IP Addresses to announce behind a NAT [=127.0.0.1].
94-
-e, --disc-ip Discovery listen address [=0.0.0.0].
95-
-u, --disc-port Discovery (UDP) port [=8090].
96-
--net-privkey Source of network (secp256k1) private key file path or name [=key].
97-
-b, --bootstrap-node Specifies one or more bootstrap nodes to use when connecting to the network.
98-
--max-peers The maximum number of peers to connect to [=160].
99-
--agent-string Node agent string which is used as identifier in network [=Codex].
100-
--api-bindaddr The REST API bind address [=127.0.0.1].
101-
-p, --api-port The REST Api port [=8080].
102-
--api-cors-origin The REST Api CORS allowed origin for downloading data. '*' will allow all
103-
origins, '' will allow none. [=Disallow all cross origin requests to download
104-
data].
105-
--repo-kind Backend for main repo store (fs, sqlite, leveldb) [=fs].
106-
-q, --storage-quota The size of the total storage quota dedicated to the node [=$DefaultQuotaBytes].
107-
-t, --block-ttl Default block timeout in seconds - 0 disables the ttl [=$DefaultBlockTtl].
108-
--block-mi Time interval in seconds - determines frequency of block maintenance cycle: how
109-
often blocks are checked for expiration and cleanup
110-
[=$DefaultBlockMaintenanceInterval].
111-
--block-mn Number of blocks to check every maintenance cycle [=1000].
112-
-c, --cache-size The size of the block cache, 0 disables the cache - might help on slow hardrives
113-
[=0].
114-
115-
Available sub-commands:
116-
117-
codex persistence [OPTIONS]... command
118-
119-
The following options are available:
120-
121-
--eth-provider The URL of the JSON-RPC API of the Ethereum node [=ws://localhost:8545].
122-
--eth-account The Ethereum account that is used for storage contracts.
123-
--eth-private-key File containing Ethereum private key for storage contracts.
124-
--marketplace-address Address of deployed Marketplace contract.
125-
--validator Enables validator, requires an Ethereum node [=false].
126-
--validator-max-slots Maximum number of slots that the validator monitors [=1000].
127-
If set to 0, the validator will not limit the maximum number of slots it
128-
monitors.
129-
--validator-groups Slot validation groups [=ValidationGroups.none].
130-
A number indicating total number of groups into which the whole slot id space
131-
will be divided. The value must be in the range [2, 65535]. If not provided, the
132-
validator will observe the whole slot id space and the value of the
133-
--validator-group-index parameter will be ignored. Powers of twos are advised
134-
for even distribution.
135-
--validator-group-index Slot validation group index [=0].
136-
The value provided must be in the range [0, validatorGroups). Ignored when
137-
--validator-groups is not provided. Only slot ids satisfying condition [(slotId
138-
mod validationGroups) == groupIndex] will be observed by the validator.
139-
140-
Available sub-commands:
141-
142-
codex persistence prover [OPTIONS]...
143-
144-
The following options are available:
145-
146-
--circom-r1cs The r1cs file for the storage circuit.
147-
--circom-wasm The wasm file for the storage circuit.
148-
--circom-zkey The zkey file for the storage circuit.
149-
--circom-no-zkey Ignore the zkey file - use only for testing! [=false].
150-
--proof-samples Number of samples to prove [=5].
151-
--max-slot-depth The maximum depth of the slot tree [=32].
152-
--max-dataset-depth The maximum depth of the dataset tree [=8].
153-
--max-block-depth The maximum depth of the network block merkle tree [=5].
154-
--max-cell-elements The maximum number of elements in a cell [=67].
155-
```
156-
157-
#### Logging
158-
159-
Codex uses [Chronicles](https://github.com/status-im/nim-chronicles) logging
160-
library, which allows great flexibility in working with logs.
161-
Chronicles has the concept of topics, which categorize log entries into
162-
semantic groups.
163-
164-
Using the `log-level` parameter, you can set the top-level log level like
165-
`--log-level="trace"`, but more importantly, you can set log levels for
166-
specific topics like `--log-level="info; trace: marketplace,node; error: blockexchange"`,
167-
which sets the top-level log level to `info` and then for topics
168-
`marketplace` and `node` sets the level to `trace` and so on.
169-
170-
### Guides
45+
## Guides
17146

17247
To get acquainted with Codex, consider:
173-
* running the simple [Codex Two-Client Test](docs/TwoClientTest.md) for
174-
a start, and;
175-
* if you are feeling more adventurous, try
176-
[Running a Local Codex Network with Marketplace Support](docs/Marketplace.md)
177-
using a local blockchain as well.
48+
* running the simple [Codex Two-Client Test](https://docs.codex.storage/learn/local-two-client-test) for a start, and;
49+
* if you are feeling more adventurous, try [Running a Local Codex Network with Marketplace Support](https://docs.codex.storage/learn/local-marketplace) using a local blockchain as well.
17850

17951
## API
18052

181-
The client exposes a REST API that can be used to interact with the clients.
182-
Overview of the API can be found on [api.codex.storage](https://api.codex.storage).
53+
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](https://api.codex.storage).

docs/DownloadFlow.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

0 commit comments

Comments
 (0)