Skip to content
This repository has been archived by the owner on Oct 12, 2022. It is now read-only.

Latest commit

 

History

History
93 lines (65 loc) · 3.5 KB

configuration.md

File metadata and controls

93 lines (65 loc) · 3.5 KB
Raw

Ariadne configuration

Ariadne uses the Dhall language for its configuration files and command line options to override values from files. Example configuration can be found in the config/ directory.

Path to the configuration file can be specified using --config option. By default <XdgConfig>/ariadne/ariadne-config.dhall is used, where <XdgConfig> is a system-dependent standard directory for local configuration files (~/.config on Linux or MacOS, %APPDATA% on Windows). If some value in the configuration is a relative file path, it's treated as relative to the directory in which main configuration file (e. g. ariadne-config.dhall) is located. There are special values which can be used in configuration as file paths:

  • @DATA is a system-dependent standard directory for local data (~/.local/share on Linux or MacOS, %APPDATA% on Windows) suffixed with /ariadne.
  • @PWD is the directory from which Ariadne executable is launched.

If configuration file is not found, default configuration will be used which is compatible with Cardano Mainnet.

Each option from the configuration can be overridden from the command line. Use --help flag for more details.

Ariadne configuration consists of configurations of several components: Cardano, Wallet, Update, History. In the following we describe configuration of each component in detail.

Cardano configuration

Cardano configuration contains parameters which are used by the underlying Cardano node.

configuration-options defines Configuration used by Cardano node. For more details on that please read the documentation the cardano-sl repository. If configuration-path doesn't exist, static configuration will be dumped to that path.

log-config is the path to the logging configuration (as used by log-warper). If it's not provided a reasonable default configuration will be used.

log-prefix is the path prepended to all paths in logging configuration. Basically a directory where logs will be written.

rebuild-db can be set to True to clean node's databases at the beginning.

db-path is the path to the node's databases.

ekg-params can be set to enable EKG monitoring (see the ekg library).

keyfile is the path to the file with secret keys.

default-port is the default port to bind to.

node-id is the identifier of the node in the network.

topology is the path to YAML file with the network topology. If it's not provided default topology will be used to communicate with mainnet nodes.

Wallet configuration

Wallet configuration has only one value with the key entropy-size. It specifies default number of bytes in entropy used to generate wallets. This value can be overridden by an argument of the new-wallet command.

Update configuration

Update configuration parameterizes update checker.

version-check-url is used to get latest software version.

update-url is displayed in the message about new version.

check-delay specifies (in seconds) how often we check for a new version.

History configuration

History configuration has only one value with the key path. It's a path to the file with command history.

Logging configuration

History configuration has only one value with the key path. Logs produced by Ariadne itself will be in that folder. Note that Cardano uses different machinery for logging, so its logs are configured by Cardano configuration.