This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
how_to_edit_qortal_core_settings [04/11/2022 12:52] – created - WIP quickmythril | how_to_edit_qortal_core_settings [05/22/2023 14:34] (current) – Removed bindAddress quickmythril | ||
---|---|---|---|
Line 4: | Line 4: | ||
===== settings.json File Information ===== | ===== settings.json File Information ===== | ||
- | To configure your Qortal Core settings, you can open and edit the settings.json file using any text editor. | + | **Caution: The settings.json file should |
- | The settings file is written using the standard JSON format. | + | To configure your Qortal Core settings, you can open and edit the settings.json file using any text editor. |
+ | |||
+ | Note: There is also a settings.json file in " | ||
+ | |||
+ | The settings file is written using the standard JSON format. | ||
< | < | ||
Line 14: | Line 18: | ||
< | < | ||
- | ===== Available | + | ===== Commonly Used Settings ===== |
The full list of user-customizable settings (and their default values) can be found at the following link: | The full list of user-customizable settings (and their default values) can be found at the following link: | ||
Line 20: | Line 24: | ||
**Here is explanation of the most commonly used settings:** | **Here is explanation of the most commonly used settings:** | ||
- | |||
- | **bindAddress** - Adding " | ||
**apiDocumentationEnabled** - Setting this to true will enable the API Documentation page, found at [[http:// | **apiDocumentationEnabled** - Setting this to true will enable the API Documentation page, found at [[http:// | ||
+ | |||
+ | **domainMapEnabled** - This is disabled by default. | ||
**autoUpdateEnabled** - Setting this to false will disable the Core from automatically updating when a new version is released and approved. | **autoUpdateEnabled** - Setting this to false will disable the Core from automatically updating when a new version is released and approved. | ||
**repositoryMaintenanceMinInterval & repositoryMaintenanceMaxInterval** - These settings determine the timeframe in which the database will be automatically " | **repositoryMaintenanceMinInterval & repositoryMaintenanceMaxInterval** - These settings determine the timeframe in which the database will be automatically " | ||
- | |||
- | **topOnly** - Setting this to true will enable "top only sync" which results in a much smaller database, however it will prevent the ability to look up data from older blocks. | ||
**bootstrap** - Setting this to false will prevent the Core from automatically downloading the bootstrap file when no database is found. | **bootstrap** - Setting this to false will prevent the Core from automatically downloading the bootstrap file when no database is found. | ||
+ | |||
+ | **isTestNet** - Setting this to true is required for anyone wanting to run a Qortal node on the test net. More information regarding this will be added to its own wiki page. | ||
+ | |||
+ | **listenPort** - The default port is 12392. | ||
+ | |||
+ | **minBlockchainPeers** - This specifies the minimum number of connected peers which must be at a given block height to be able to sync that block to your local database. | ||
+ | |||
+ | **minPeerVersion** - This is a string (so it requires quotes) that determines the minimum Core version required by peers for your node to sync with them. Other peers can still request blocks from your node, unless you disable the following setting. | ||
+ | |||
+ | **allowConnectionsWithOlderPeerVersions** - Setting this to false will prevent peers running a Core version lower than that set in the previous setting from being able to request blocks from your node. | ||
+ | |||
+ | **minPeerConnectionTime & maxPeerConnectionTime** - These settings determine the amount of time that any given peer will remain connected. | ||
+ | |||
+ | **repositoryPath** - This specifies the location where the Core can find or create the blockchain database. | ||
+ | |||
+ | **testNtpOffset** - Recommended for advanced users only. Qubes & Whonix use " | ||
+ | |||
+ | **qdnEnabled** - Setting this to false will disable all QDN / data hosting features, preventing your node from storing any associated content. | ||
+ | |||
+ | **dataPath** - This is similar to the repositoryPath setting. | ||
+ | |||
+ | **storagePolicy** - The default for this setting is " | ||
+ | |||
+ | **relayModeEnabled** - By default, the Core will act as a "go between" | ||
+ | |||
+ | **maxStorageCapacity** - This setting can be used to limit the amount of space available for QDN data hosting (in the folder specified by the dataPath setting). |