description: Start from using rings-node

Install a native node

Installation

You can install the rings binary from a prebuilt release, from Cargo, or from source.

Every release ships rings for macOS (aarch64-apple-darwin, x86_64-apple-darwin) and Linux (x86_64-unknown-linux-musl, a static binary that runs on any distribution), plus the WebAssembly package for browsers. Download the archive for your platform, unpack it, and put rings on your PATH:

unzip rings-v0.38.0-aarch64-apple-darwin.zip
install -m 755 rings /usr/local/bin/rings
rings --version

From Cargo

The workspace denies compiler warnings, so build with the Rust release pinned in the repository’s rust-toolchain.toml; a newer compiler can add a warning that fails the build:

cargo +1.97.0 install --locked rings-node

Rings Network is written in Rust. Cargo is a package management tool for the Rust language. You can learn about how to install and use Cargo here.

From Source

git clone https://github.com/RingsNetwork/rings
cd rings
cargo install --path crates/node

Usage

rings <command> [options]

Commands

help: displays the usage information.
init: creates a default configuration file, ~/.rings/config.yaml unless --location says otherwise. This file can be edited to customize the behavior of the rings-node daemon. The generated file states every section explicitly, including a complete gateway: section with enabled: false (see Native Gateway).
run: runs the rings-node daemon. By default, the daemon will use ~/.rings/config.yaml for configuration. Use the “-c” or “–config” option to specify a custom configuration file.

Options

-c, --config <FILE>: specifies a custom configuration file to use instead of the default ~/.rings/config.yaml. The configuration file is used to specify the network configuration, account settings, and other parameters that control the behavior of the rings-node daemon.
-h, --help: displays the usage information.
-V, --version: displays the version information for rings-node.

Keyboard shortcuts

Rings Network