Configure
Command Line Interface
The Rootstock node can be started with different CLI flags.
Setting config preferences
See how to set your config:
… to run the node.
You need to restart the node if you've changed any configuration option.
Using Ubuntu or Docker
Your node's config file is in /etc/rsk
.
Default configurations are defined there and they are the same as these ones.
You should edit the config related with the network you are using (mainnet.conf
, testnet.conf
, regtest.conf
).
Check here all the configuration options you could change.
Using Windows
For other operating systems, including Windows, please use the -Drsk.conf.file
option as specified below.
Using java
command
1. Create a .conf
file
You can create a file with the configuration options that you want to replace from the default. Default configurations are defined here.
The extension of the file must be .conf
.
Check /node-operators/setup/configuration/reference/ for all the configuration option.
As an example, if you want to change the default database directory
, your config file should only contain:
database {
dir = /new/path/for/database
reset = false
}
2. Specify your config file path
To apply your configuration options, you need to set your own config file's path when you run your node.
This can be done in two ways:
- Running the node with the
java
command, add-Drsk.conf.file=path/to/your/file.conf
- Compiling the node with IntelliJ, add to VM options:
-Drsk.conf.file=path/to/your/file.conf
Using RocksDB
- Starting from RSKj HOP v4.2.0, RocksDB is no longer experimental. As of the most recent version, RocksDB has now been made the default storage library, replacing LevelDB. This change was made to tackle maintainability and performance issues of LevelDB.
- Previously, RSKj ran using LevelDB by default, with the option to switch to RocksDB. Now, RocksDB is the default storage option, aiming to enable higher performance within the RSKj nodes.
Get Started
RSKj nodes run using RocksDB by default (See important info section). To switch back to LevelDB, modify the relevant RSKj config file (*.conf
) and set the config: keyvalue.datasource=leveldb
.
The keyvalue.datasource
property in the config
may only be either rocksdb
or leveldb
.
If you wish to switch between the different storage options, for example from
leveldb
torocksdb
or vice versa, you must restart the node with the import option.
The following sample command shows how to do this when
the RSKj node was previously running the default (leveldb
),
and wants to run with rocksdb
next.
Note the use of the
--import
flag, which resets and re-imports the database.
java -Dkeyvalue.datasource=rocksdb -jar ./rskj-core/build/libs/rskj-core-*-all.jar --testnet --import
Advantages:
- RocksDB uses a log structured database engine, written entirely in C++, for maximum performance. Keys and values are just arbitrarily-sized byte streams.
- RocksDB is optimized for fast, low latency storage such as flash drives and high-speed disk drives. RocksDB exploits the full potential of high read/write rates offered by flash or RAM.
- RocksDB is adaptable to different workloads. From database storage engines such as MyRocks to application data caching to embedded workloads, RocksDB can be used for a variety of data needs.
- RocksDB provides basic operations such as opening and closing a database, reading and writing to more advanced operations such as merging and compaction filters.