Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +Configuration is done via environment variables and flags.
+See the Daemon section for more information on how to use the ceramic-one flags.
The following environment variables are important, refer to the page above for the complete list.
+CERAMIC_ONE_NETWORK: Ceramic network (default: testnet-clay)CERAMIC_ONE_STORE_DIR: Path to storage directory (default: ~/.ceramic-one)CERAMIC_ONE_BIND_ADDRESS: Bind address of the metrics endpoint (default: 5001)CERAMIC_ONE_METRICS_BIND_ADDRESS: Bind address of the metrics endpoint (default: 9464)CERAMIC_ONE_SWARM_ADDRESSES: Listen address of the p2p swarm (default: /ip4/0.0.0.0/tcp/4001)CERAMIC_ONE_LOCAL_NETWORK_IDDocker images for rust-ceramic are available from our AWS container registry.
+Currently, the latest release is 0.12.0.
docker pull public.ecr.aws/r5b3e0r5/3box/ceramic-one:0.12.0
+The daemon command is used to start the Ceramic One daemon. The daemon is the main process that runs the Ceramic network and provides the HTTP API for interacting with the network.
ceramic-one daemon --help
Run a daemon process
+
+Usage: ceramic-one daemon [OPTIONS]
+
+Options:
+ -b, --bind-address <BIND_ADDRESS>
+ Bind address of the API endpoint
+
+ [env: CERAMIC_ONE_BIND_ADDRESS=]
+ [default: 127.0.0.1:5001]
+
+ --swarm-addresses <SWARM_ADDRESSES>
+ Listen address of the p2p swarm
+
+ [env: CERAMIC_ONE_SWARM_ADDRESSES=]
+ [default: /ip4/0.0.0.0/tcp/4001 /ip4/0.0.0.0/udp/4001/quic-v1]
+
+ --extra-ceramic-peer-addresses <EXTRA_CERAMIC_PEER_ADDRESSES>
+ Extra addresses of peers that participate in the Ceramic network. A best-effort attempt will be made to maintain a connection to these addresses
+
+ [env: CERAMIC_ONE_EXTRA_CERAMIC_PEER_ADDRESSES=]
+
+ -s, --store-dir <STORE_DIR>
+ Path to storage directory
+
+ [env: CERAMIC_ONE_STORE_DIR=]
+
+ -m, --metrics-bind-address <METRICS_BIND_ADDRESS>
+ Bind address of the metrics endpoint
+
+ [env: CERAMIC_ONE_METRICS_BIND_ADDRESS=]
+ [default: 127.0.0.1:9464]
+
+ --metrics
+ When true metrics will be exported
+
+ [env: CERAMIC_ONE_METRICS=]
+
+ --tracing
+ When true traces will be exported
+
+ [env: CERAMIC_ONE_TRACING=]
+
+ --network <NETWORK>
+ Unique key used to find other Ceramic peers via the DHT
+
+ [env: CERAMIC_ONE_NETWORK=]
+ [default: testnet-clay]
+
+ Possible values:
+ - mainnet: Production network
+ - testnet-clay: Test network
+ - dev-unstable: Development network
+ - local: Local network with unique id
+ - in-memory: Singleton network in memory
+
+ --local-network-id <LOCAL_NETWORK_ID>
+ Unique id when the network type is 'local'
+
+ [env: CERAMIC_ONE_LOCAL_NETWORK_ID=]
+
+ --mdns
+ When set mdns will be used to discover peers
+
+ [env: CERAMIC_ONE_MDNS=]
+
+ --disable-autonat
+ When set autonat will not be used to discover external address or allow other peers to directly dial the local peer
+
+ [env: CERAMIC_ONE_DISABLE_AUTONAT=]
+
+ --log-format <LOG_FORMAT>
+ Specify the format of log events
+
+ [env: CERAMIC_ONE_LOG_FORMAT=]
+ [default: multi-line]
+
+ Possible values:
+ - multi-line: Format log events on multiple lines using ANSI colors
+ - single-line: Format log events on a single line using ANSI colors
+ - json: Format log events newline delimited JSON objects. No ANSI colors are used
+
+ --max-conns-out <MAX_CONNS_OUT>
+ Specify maximum established outgoing connections
+
+ [env: CERAMIC_ONE_MAX_CONNS_OUT=]
+ [default: 2000]
+
+ --max-conns-in <MAX_CONNS_IN>
+ Specify maximum established incoming connections
+
+ [env: CERAMIC_ONE_MAX_CONNS_IN=]
+ [default: 2000]
+
+ --max-conns-pending-out <MAX_CONNS_PENDING_OUT>
+ Specify maximum pending outgoing connections
+
+ [env: CERAMIC_ONE_MAX_CONNS_PENDING_OUT=]
+ [default: 256]
+
+ --max-conns-pending-in <MAX_CONNS_PENDING_IN>
+ Specify maximum pending incoming connections
+
+ [env: CERAMIC_ONE_MAX_CONNS_PENDING_IN=]
+ [default: 256]
+
+ --max-conns-per-peer <MAX_CONNS_PER_PEER>
+ Specify maximum established connections per peer regardless of direction (incoming or outgoing)
+
+ [env: CERAMIC_ONE_MAX_CONNS_PER_PEER=]
+ [default: 8]
+
+ --idle-conns-timeout-ms <IDLE_CONNS_TIMEOUT_MS>
+ Specify idle connection timeout in milliseconds
+
+ [env: CERAMIC_ONE_IDLE_CONNS_TIMEOUT_MS=]
+ [default: 30000]
+
+ --kademlia-replication <KADEMLIA_REPLICATION>
+ Sets to how many closest peers a record is replicated
+
+ [env: CERAMIC_ONE_KADEMLIA_REPLICATION=]
+ [default: 20]
+
+ --kademlia-parallelism <KADEMLIA_PARALLELISM>
+ Sets the allowed level of parallelism for iterative queries
+
+ [env: CERAMIC_ONE_KADEMLIA_PARALLELISM=]
+ [default: 16]
+
+ --kademlia-query-timeout-secs <KADEMLIA_QUERY_TIMEOUT_SECS>
+ Sets the timeout in seconds for a single query.
+
+ **Note**: A single query usually comprises at least as many requests as the replication factor, i.e. this is not a request timeout.
+
+ [env: CERAMIC_ONE_KADEMLIA_QUERY_TIMEOUT_SECS=]
+ [default: 60]
+
+ --kademlia-provider-publication-interval-secs <KADEMLIA_PROVIDER_PUBLICATION_INTERVAL_SECS>
+ Sets the interval in seconds at which provider records for keys provided by the local node are re-published.
+
+ `0` means that stored provider records are never automatically re-published.
+
+ Must be significantly less than the provider record TTL.
+
+ [env: CERAMIC_ONE_KADEMLIA_PROVIDER_PUBLICATION_INTERVAL_SECS=]
+ [default: 43200]
+
+ --kademlia-provider-record-ttl-secs <KADEMLIA_PROVIDER_RECORD_TTL_SECS>
+ Sets the TTL in seconds for provider records.
+
+ `0` means that stored provider records never expire.
+
+ Must be significantly larger than the provider publication interval.
+
+ [env: CERAMIC_ONE_KADEMLIA_PROVIDER_RECORD_TTL_SECS=]
+ [default: 86400]
+
+ -h, --help
+ Print help (see a summary with '-h')
+The events command is used to display the events that have been emitted by the Ceramic daemon. This can be useful for debugging and monitoring purposes.
ceramic-one events slurp --help
Slurp events into the local event database
+
+Usage: ceramic-one events slurp [OPTIONS]
+
+Options:
+ -i, --input-ipfs-path <INPUT_IPFS_PATH>
+ The path to the ipfs_repo [eg: ~/.ipfs/blocks]
+ -c, --input-ceramic-db <INPUT_CERAMIC_DB>
+ The path to the input_ceramic_db [eg: ~/.ceramic-one/db.sqlite3]
+ -o, --output-ceramic-path <OUTPUT_CERAMIC_PATH>
+ The path to the output_ceramic_db [eg: ~/.ceramic-one/db.sqlite3]
+ -h, --help
+ Print help
+rust-ceramic is a Rust library for working with the Ceramic Network and is under active development.
The current implementation requires a running js-ceramic daemon to be available.
+Replace IPFS as the data storage layer for js-ceramic with a Rust-based implementation.
+rust-ceramic is currently in an alpha state and is not yet suitable for production use. The API is subject to change and there are known limitations and bugs.
+ +Installation of rust-ceramic is covered here, but a functioning js-ceramic node requires a running js-ceramic daemon to be available.
+See developers.ceramic.network for instructions on how to install js-ceramic.
+ +rust-ceramic is a Rust library for working with the Ceramic Network and is under active development.
The current implementation requires a running js-ceramic daemon to be available.
+Replace IPFS as the data storage layer for js-ceramic with a Rust-based implementation.
+rust-ceramic is currently in an alpha state and is not yet suitable for production use. The API is subject to change and there are known limitations and bugs.
+ +Available metrics are:
+ceramic_api_requests_total: Total number of Ceramic API requestsceramic_one_info: Information about the Ceramic nodeceramic_store_key_insert_count_total: Total number of keys inserted into the storeceramic_store_value_insert_count_total: Total number of values inserted into the storeceramic_store_store_query_durations_[sum, buckets, count]: Store query durationsceramic_api_request_durations_[sum, buckets, count]: API request durationsceramic_api_api_info: Information about the Ceramic APIrust-ceramic is a Rust library for working with the Ceramic Network and is under active development.
The current implementation requires a running js-ceramic daemon to be available.
+Replace IPFS as the data storage layer for js-ceramic with a Rust-based implementation.
+rust-ceramic is currently in an alpha state and is not yet suitable for production use. The API is subject to change and there are known limitations and bugs.
+Installation of rust-ceramic is covered here, but a functioning js-ceramic node requires a running js-ceramic daemon to be available.
+See developers.ceramic.network for instructions on how to install js-ceramic.
+You can download the latest release from the rust-ceramic GitHub releases page.
+Building from source requires the following dependencies:
+On Ubuntu, you can install most dependencies by running the following command:
+sudo apt-get install -y build-essential pkg-config openssl libssl-dev unzip
+On MacOS, you can install most dependencies by running the following command:
+brew install openssl
+Installing protobuf and protoc can be done by following the instructions on the protobuf website.
Currently, rust-ceramic uses version 3.20.1.
+Install this version on x86 Linux by running the following commands:
PROTOC_VERSION=3.20.1
+PROTOC_ZIP=protoc-$PROTOC_VERSION-linux-x86_64.zip
+curl --retry 3 --retry-max-time 90 -OL https://github.com/protocolbuffers/protobuf/releases/download/v$PROTOC_VERSION/$PROTOC_ZIP \
+ && unzip -o $PROTOC_ZIP -d /usr/local bin/protoc \
+ && unzip -o $PROTOC_ZIP -d /usr/local 'include/*' \
+ && rm -f $PROTOC_ZIP
+To install from source, you will need to have Rust installed. You can install Rust by following the instructions on the Rust website.
+Once the pre-requisites are satisfied, you can build rust-ceramic by running the following command:
make build
+The generated binary will be located at target/release/ceramic.
Verify it's functioning by running:
+./target/release/ceramic-one --help
+Docker images for rust-ceramic are available from our AWS container registry.
+Currently, the latest release is 0.12.0.
docker pull public.ecr.aws/r5b3e0r5/3box/ceramic-one:0.12.0
+Start a daemon process for use by a js-ceramic instance.
+See Configuration for more information on how to customize the daemon.
+The default configuration:
+4001 for peer-to-peer communication5001 for the HTTP API (private)9464 for metrics (private)~/.ceramic-one/See the configuration section for more information on how to customize the daemon.
+Run it with:
+ceramic-one daemon
+ceramic-one events
+Configuration is done via environment variables and flags.
+See the Daemon section for more information on how to use the ceramic-one flags.
The following environment variables are important, refer to the page above for the complete list.
+CERAMIC_ONE_NETWORK: Ceramic network (default: testnet-clay)CERAMIC_ONE_STORE_DIR: Path to storage directory (default: ~/.ceramic-one)CERAMIC_ONE_BIND_ADDRESS: Bind address of the metrics endpoint (default: 5001)CERAMIC_ONE_METRICS_BIND_ADDRESS: Bind address of the metrics endpoint (default: 9464)CERAMIC_ONE_SWARM_ADDRESSES: Listen address of the p2p swarm (default: /ip4/0.0.0.0/tcp/4001)CERAMIC_ONE_LOCAL_NETWORK_IDAvailable metrics are:
+ceramic_api_requests_total: Total number of Ceramic API requestsceramic_one_info: Information about the Ceramic nodeceramic_store_key_insert_count_total: Total number of keys inserted into the storeceramic_store_value_insert_count_total: Total number of values inserted into the storeceramic_store_store_query_durations_[sum, buckets, count]: Store query durationsceramic_api_request_durations_[sum, buckets, count]: API request durationsceramic_api_api_info: Information about the Ceramic APIThe daemon command is used to start the Ceramic One daemon. The daemon is the main process that runs the Ceramic network and provides the HTTP API for interacting with the network.
ceramic-one daemon --help
Run a daemon process
+
+Usage: ceramic-one daemon [OPTIONS]
+
+Options:
+ -b, --bind-address <BIND_ADDRESS>
+ Bind address of the API endpoint
+
+ [env: CERAMIC_ONE_BIND_ADDRESS=]
+ [default: 127.0.0.1:5001]
+
+ --swarm-addresses <SWARM_ADDRESSES>
+ Listen address of the p2p swarm
+
+ [env: CERAMIC_ONE_SWARM_ADDRESSES=]
+ [default: /ip4/0.0.0.0/tcp/4001 /ip4/0.0.0.0/udp/4001/quic-v1]
+
+ --extra-ceramic-peer-addresses <EXTRA_CERAMIC_PEER_ADDRESSES>
+ Extra addresses of peers that participate in the Ceramic network. A best-effort attempt will be made to maintain a connection to these addresses
+
+ [env: CERAMIC_ONE_EXTRA_CERAMIC_PEER_ADDRESSES=]
+
+ -s, --store-dir <STORE_DIR>
+ Path to storage directory
+
+ [env: CERAMIC_ONE_STORE_DIR=]
+
+ -m, --metrics-bind-address <METRICS_BIND_ADDRESS>
+ Bind address of the metrics endpoint
+
+ [env: CERAMIC_ONE_METRICS_BIND_ADDRESS=]
+ [default: 127.0.0.1:9464]
+
+ --metrics
+ When true metrics will be exported
+
+ [env: CERAMIC_ONE_METRICS=]
+
+ --tracing
+ When true traces will be exported
+
+ [env: CERAMIC_ONE_TRACING=]
+
+ --network <NETWORK>
+ Unique key used to find other Ceramic peers via the DHT
+
+ [env: CERAMIC_ONE_NETWORK=]
+ [default: testnet-clay]
+
+ Possible values:
+ - mainnet: Production network
+ - testnet-clay: Test network
+ - dev-unstable: Development network
+ - local: Local network with unique id
+ - in-memory: Singleton network in memory
+
+ --local-network-id <LOCAL_NETWORK_ID>
+ Unique id when the network type is 'local'
+
+ [env: CERAMIC_ONE_LOCAL_NETWORK_ID=]
+
+ --mdns
+ When set mdns will be used to discover peers
+
+ [env: CERAMIC_ONE_MDNS=]
+
+ --disable-autonat
+ When set autonat will not be used to discover external address or allow other peers to directly dial the local peer
+
+ [env: CERAMIC_ONE_DISABLE_AUTONAT=]
+
+ --log-format <LOG_FORMAT>
+ Specify the format of log events
+
+ [env: CERAMIC_ONE_LOG_FORMAT=]
+ [default: multi-line]
+
+ Possible values:
+ - multi-line: Format log events on multiple lines using ANSI colors
+ - single-line: Format log events on a single line using ANSI colors
+ - json: Format log events newline delimited JSON objects. No ANSI colors are used
+
+ --max-conns-out <MAX_CONNS_OUT>
+ Specify maximum established outgoing connections
+
+ [env: CERAMIC_ONE_MAX_CONNS_OUT=]
+ [default: 2000]
+
+ --max-conns-in <MAX_CONNS_IN>
+ Specify maximum established incoming connections
+
+ [env: CERAMIC_ONE_MAX_CONNS_IN=]
+ [default: 2000]
+
+ --max-conns-pending-out <MAX_CONNS_PENDING_OUT>
+ Specify maximum pending outgoing connections
+
+ [env: CERAMIC_ONE_MAX_CONNS_PENDING_OUT=]
+ [default: 256]
+
+ --max-conns-pending-in <MAX_CONNS_PENDING_IN>
+ Specify maximum pending incoming connections
+
+ [env: CERAMIC_ONE_MAX_CONNS_PENDING_IN=]
+ [default: 256]
+
+ --max-conns-per-peer <MAX_CONNS_PER_PEER>
+ Specify maximum established connections per peer regardless of direction (incoming or outgoing)
+
+ [env: CERAMIC_ONE_MAX_CONNS_PER_PEER=]
+ [default: 8]
+
+ --idle-conns-timeout-ms <IDLE_CONNS_TIMEOUT_MS>
+ Specify idle connection timeout in milliseconds
+
+ [env: CERAMIC_ONE_IDLE_CONNS_TIMEOUT_MS=]
+ [default: 30000]
+
+ --kademlia-replication <KADEMLIA_REPLICATION>
+ Sets to how many closest peers a record is replicated
+
+ [env: CERAMIC_ONE_KADEMLIA_REPLICATION=]
+ [default: 20]
+
+ --kademlia-parallelism <KADEMLIA_PARALLELISM>
+ Sets the allowed level of parallelism for iterative queries
+
+ [env: CERAMIC_ONE_KADEMLIA_PARALLELISM=]
+ [default: 16]
+
+ --kademlia-query-timeout-secs <KADEMLIA_QUERY_TIMEOUT_SECS>
+ Sets the timeout in seconds for a single query.
+
+ **Note**: A single query usually comprises at least as many requests as the replication factor, i.e. this is not a request timeout.
+
+ [env: CERAMIC_ONE_KADEMLIA_QUERY_TIMEOUT_SECS=]
+ [default: 60]
+
+ --kademlia-provider-publication-interval-secs <KADEMLIA_PROVIDER_PUBLICATION_INTERVAL_SECS>
+ Sets the interval in seconds at which provider records for keys provided by the local node are re-published.
+
+ `0` means that stored provider records are never automatically re-published.
+
+ Must be significantly less than the provider record TTL.
+
+ [env: CERAMIC_ONE_KADEMLIA_PROVIDER_PUBLICATION_INTERVAL_SECS=]
+ [default: 43200]
+
+ --kademlia-provider-record-ttl-secs <KADEMLIA_PROVIDER_RECORD_TTL_SECS>
+ Sets the TTL in seconds for provider records.
+
+ `0` means that stored provider records never expire.
+
+ Must be significantly larger than the provider publication interval.
+
+ [env: CERAMIC_ONE_KADEMLIA_PROVIDER_RECORD_TTL_SECS=]
+ [default: 86400]
+
+ -h, --help
+ Print help (see a summary with '-h')
+The events command is used to display the events that have been emitted by the Ceramic daemon. This can be useful for debugging and monitoring purposes.
ceramic-one events slurp --help
Slurp events into the local event database
+
+Usage: ceramic-one events slurp [OPTIONS]
+
+Options:
+ -i, --input-ipfs-path <INPUT_IPFS_PATH>
+ The path to the ipfs_repo [eg: ~/.ipfs/blocks]
+ -c, --input-ceramic-db <INPUT_CERAMIC_DB>
+ The path to the input_ceramic_db [eg: ~/.ceramic-one/db.sqlite3]
+ -o, --output-ceramic-path <OUTPUT_CERAMIC_PATH>
+ The path to the output_ceramic_db [eg: ~/.ceramic-one/db.sqlite3]
+ -h, --help
+ Print help
+You can download the latest release from the rust-ceramic GitHub releases page.
+ +Building from source requires the following dependencies:
+On Ubuntu, you can install most dependencies by running the following command:
+sudo apt-get install -y build-essential pkg-config openssl libssl-dev unzip
+On MacOS, you can install most dependencies by running the following command:
+brew install openssl
+Installing protobuf and protoc can be done by following the instructions on the protobuf website.
Currently, rust-ceramic uses version 3.20.1.
+Install this version on x86 Linux by running the following commands:
PROTOC_VERSION=3.20.1
+PROTOC_ZIP=protoc-$PROTOC_VERSION-linux-x86_64.zip
+curl --retry 3 --retry-max-time 90 -OL https://github.com/protocolbuffers/protobuf/releases/download/v$PROTOC_VERSION/$PROTOC_ZIP \
+ && unzip -o $PROTOC_ZIP -d /usr/local bin/protoc \
+ && unzip -o $PROTOC_ZIP -d /usr/local 'include/*' \
+ && rm -f $PROTOC_ZIP
+To install from source, you will need to have Rust installed. You can install Rust by following the instructions on the Rust website.
+Once the pre-requisites are satisfied, you can build rust-ceramic by running the following command:
make build
+The generated binary will be located at target/release/ceramic.
Verify it's functioning by running:
+./target/release/ceramic-one --help
+Start a daemon process for use by a js-ceramic instance.
+See Configuration for more information on how to customize the daemon.
+The default configuration:
+4001 for peer-to-peer communication5001 for the HTTP API (private)9464 for metrics (private)~/.ceramic-one/See the configuration section for more information on how to customize the daemon.
+Run it with:
+ceramic-one daemon
+ceramic-one events
+