diff --git a/Config-README.md b/Config-README.md new file mode 100644 index 0000000000..d79215330d --- /dev/null +++ b/Config-README.md @@ -0,0 +1,77 @@ +Optimizing Your Node for Maximum Performance and Efficiency +------------------- + +#### *RPC and Network Setting need to be added to raven.conf file* + +#### Config file found here: +- **Windows**: C:\Users\\AppData\Roaming\Raven\raven.conf +- **Linux**: /home//.raven/raven.conf +- **Mac**: /Users//Library/Application Support/Raven/raven.conf +- **In Wallet**: Click "Wallet" in the menu at the top, then click "Options", then click "Open Configuration File" + +## List of RPC and Network Settings: + +### Standard: + +- **rpcuser**: Username required for RPC authentication + - Example: `rpcuser=` + +- **rpcpassword**: Password required for RPC authentication + - Example: `rpcpassword=` + +- **rpcallowip**: Allow RPC requests only from localhost + - Example: `rpcallowip=127.0.0.1` + +- **rpcport**: RPC port (default is 8766) + - Example: `rpcport=8766` + +- **port**: Port for incoming P2P connections (default is 8767) + - Example: `port=8767` + +- **listen**: Enable listening for inbound P2P connections (1 = enabled) + - Example: `listen=1` + +- **server**: Enable RPC server to accept commands (1 = enabled) + - Example: `server=1` + +- **daemon**: Run as a background process (1 = enabled) + - Example: `daemon=1` + +- **txindex**: Maintain a full transaction index (1 = enabled) + - Example: `txindex=1` + +- **logtimestamps**: Include timestamps in the debug log (1 = enabled) + - Example: `logtimestamps=1` + + +### Performance: + +- **dbcache**: Size of database cache in MB (higher uses more RAM) + - Example: `dbcache=20000` + +- **coindbcache**: Size of the block database cache in MB (higher uses more RAM) + - Example: `coindbcache=20000` + +- **maxmempool**: Maximum size of memory pool in MB (higher allows more unconfirmed transactions) + - Example: `maxmempool=10000` + +- **mempoolexpiry**: Time (in hours) to keep unconfirmed transactions in memory pool before expiring + - Example: `mempoolexpiry=72` + +- **maxconnections**: Maximum number of inbound and outbound P2P connections + - Example: `maxconnections=40` + +- **maxuploadtarget**: Maximum upload target in MB per day (limits outbound data) + - Example: `maxuploadtarget=50000` + +- **blockminsize**: Minimum size of blocks in bytes + - Example: `blockminsize=100000` + +- **blockmaxsize**: Maximum size of blocks in bytes + - Example: `blockmaxsize=2000000` + +- **bloomfiltersize**: Size of the bloom filter for transaction indexing + - Example: `bloomfiltersize=30` + + + diff --git a/README.md b/README.md index 08b0cdd6b9..5481a1ad13 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,18 @@ with no central authority: managing transactions and issuing money are carried out collectively by the network. - License ------- Raven Core is released under the terms of the MIT license. See [COPYING](COPYING) for more information or see https://opensource.org/licenses/MIT. + +Optimizing Your Node for Maximum Performance and Efficiency +------------------- +[Config Readme found here.](https://github.com/RavenProject/Ravencoin/blob/master/Config-README.md) + + Development Process ------------------- @@ -37,6 +42,7 @@ The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md). Developer IRC is inactive please join us on discord in #development. https://discord.gg/fndp4NBGct + Testing -------