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.
Prebuilt binaries
Install the latest release on macOS (aarch64-apple-darwin, x86_64-apple-darwin) or Linux
(x86_64-unknown-linux-musl, aarch64-unknown-linux-gnu) with the one-line installer:
curl -fsSL https://rings.rs/install.sh | sh
The script verifies the archive’s SHA-256 checksum and installs rings to /usr/local/bin
(when writable) or ~/.local/bin. Re-run the command to upgrade in place, or pass
--version vX.Y.Z to install a specific tag:
curl -fsSL https://rings.rs/install.sh | sh -s -- --version v1.0.0-pre.3
You can also download an archive directly from
Releases, verify its .sha256 file, and
place rings on your PATH:
shasum -a 256 -c rings-v1.0.0-pre.3-aarch64-apple-darwin.zip.sha256
unzip rings-v1.0.0-pre.3-aarch64-apple-darwin.zip
install -m 755 rings /usr/local/bin/rings
rings --version
For running rings persistently under systemd or launchd, see
contrib/README.md.
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.yamlunless--locationsays otherwise. This file can be edited to customize the behavior of the rings-node daemon. The generated file states every section explicitly, including a completegateway:section withenabled: false(see Native Gateway).run: runs the rings-node daemon. By default, the daemon will use~/.rings/config.yamlfor 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.