Skip to content

Commit

Permalink
CLI Node flags and reader node instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jplgarcia committed Sep 5, 2024
1 parent 6c02246 commit 862b826
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 6 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ All notable changes to the Cartesi documentation will be documented in this file
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [v.1.5.1](https://github.com/cartesi/docs/releases/latest) - 2024-09-05

### Added
- CLI flags for CPU and Memory of the node on CLI commands page
- Note regarding enviroment variable for reader node configurations on deployment page

### Changed
- Added link to Machine Docs on the Architecture Page

### Removed
- Removed comments on reader node being still in development on Architecture Page

## [v.1.5.0](https://github.com/cartesi/docs/releases/latest) - 2024-08-09

### Added
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,6 @@ The Cartesi Rollups Node can operate in two primary modes:

**2. Reader Nodes (In Development)**: These nodes focus on advancing the off-chain state and making it publicly available. They consume information from the blockchain but do not participate in the validation process.

:::caution important
All Cartesi Nodes function as Validator Nodes, with Reader Node functionality under active development.
:::


## Data Flow and Processes

The Cartesi architecture facilitates several key processes that enable the functioning of dApps. These processes include:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,18 @@ The Cartesi rollups node is distributed as a Docker image. Any popular cloud pro

Alternatively, you can use a service like [Fly.io](https://fly.io/) to deploy your application node.

:::note deploying a reader node

A reader node consumes information from the blockchain but does not participate in the validation process. It will not generate any claims.

To make your node a reader node create or modify a `.cartesi.env` file in your project directory and set:

```shell
CARTESI_FEATURE_READER_MODE_ENABLED="true"
```

:::

### Hosting on a cloud provider

1. Download the `.env` configuration file into the root directory of your application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,14 @@ cartesi run [--block-time <value>] [--epoch-length <value>] [--no-backend] [-v]
#### Flags:

- `--block-time=<value>`: Interval between blocks in seconds (default: 5).
- `--epoch-length=<value>`: length of an epoch in blocks (default: 720).
- `--epoch-length=<value>`: length of an epoch in blocks (default: 720).
- `--no-backend`: Run a node without the application code.
- `-v`, `--verbose`: Run node with detailed container logs.
- `--listen-port=<value>`: Port to listen for incoming connections (default: 8080).
- `--dry-run`: Shows the docker compose configuration.
- `--cpus=<value>`: Define the number of CPUs (eg.: 1) for the rollups-node (default is not limited).
- `--memory=<value>`: Define the amount of memory (eg.: 1024) for the rollups-node in MB (default is not limited).


---

Expand Down

0 comments on commit 862b826

Please sign in to comment.