[−][src]Module holochain_common::env_vars

Holochain uses a number of environment variables that can be set, for easy configuration for aspects of the system. Below is the complete list of them, and what they are used for.

hc run

Read more about the use of these environment variables here.

  • HC_AGENT string Set an alternative name for the agent for the development instance. Default value is testAgent. Useful for changing the agent while running multiple instances.
  • HC_INTERFACE string websocket OR http Set an interface type to use. Setting this as an environment variable will override the value of the --interface option for hc run. The default interface if neither is set is websocket.
  • HC_N3H_WORK_DIR string Eventually, there will be a directory needed by n3h for persisting data, such as remote node QoS metrics, peer lists, and non-core DHT data items such as peer discovery info. Default is temporary directory which will get removed again once the Conductor process stops. Recommended not to use this at this time.
  • HC_N3H_BOOTSTRAP_NODE string Set an external p2p bound ip4 address for another node, to bootstrap the networking discovery process. Without this, a second node will of a network will be unable to find any others. See [configuring networking](here for details.
  • HC_N3H_MODE string REAL Sets the mode N3H operates in. Must be REAL as its the only mode in n3h now.
  • HC_N3H_LOG_LEVEL char Set the logging level used globally by N3H. Must be one of the following: 't', 'd', 'i', 'w', 'e'. Each value represents its corresponding industry standard log level: Trace, Debug, Info, Warning, Error.
  • NETWORKING_CONFIG_FILE string Path to a JSON file containing configuration for the n3h networking module. More on this soon. Recommended to not use this as this time.

hc generate

  • HC_SCAFFOLD_VERSION allows you to set a string value to be used in the generated Cargo.toml. We use this override the default which points to the current version tag, which a pointer to the develop branch for our CI tests, so for example in CI we can run our tests with: HC_SCAFFOLD_VERSION='branch="develop"' and that overrides the default.

Enums

EnvVar