Skip to main content

Configuration file

The Configuration file is a TOML file that must be specified when starting Orion.

Configuration entries may be overridden by environment variables.

Properties

PropertyRequiredEnvironment variable nameDescriptionDefault
nodeurlRequiredORION_NODEURLURL advertised to Orion nodes"http://127.0.0.1:8080/"
nodeportRequiredORION_NODEPORTPort on which to listen for Orion nodes8080
nodenetworkinterfaceOptionalORION_NODENETWORKINTERFACEHost on which to listen for Orion nodes"127.0.0.1"
clienturlOptionalORION_CLIENTURLURL advertised to Ethereum clients"http://127.0.0.1:8888"
clientportOptionalORION_CLIENTPORTPort on which to listen for Ethereum clients8888
clientnetworkinterfaceOptionalORION_CLIENTNETWORKINTERFACEHost on which to listen for Ethereum clients"127.0.0.1"
workdirOptionalORION_WORKDIRData directory. This property is relevant only if you use file-based storage, such as LevelDB.. (current directory)
othernodesOptionalORION_OTHERNODESBootnodes for Orion network[] (empty list)
publickeysOptionalORION_PUBLICKEYSList of files containing public keys hosted by node[] (empty list)
privatekeysOptionalORION_PRIVATEKEYSList of files containing private keys hosted by node (corresponding order to public keys)[] (empty list)
libsodiumpathOptionalORION_LIBSODIUMPATHPath to libsodium shared libraryDependent on OS
alwayssendtoOptionalORION_ALWAYSSENDTOList of files containing public keys to include as recipients for every transaction[]
passwordsOptionalORION_PASSWORDSFile containing passwords to unlock privatekeysNot set
knownnodestorageOptionalORION_KNOWNNODESTORAGEKnown nodes storage for other Orion nodes. Must match storage in highly available scenarios. Relational databases PostgreSQL and Oracle are supported."memory"
storageOptionalORION_STORAGEStorage for payloads and related information. Relational databases PostgreSQL and Oracle are supported."leveldb"
tlsOptionalORION_TLSTLS status options"strict"
tlsservercertOptionalORION_TLSSERVERCERTServer TLS certificate"tls-server-cert.pem"
tlsserverchainOptionalORION_TLSSERVERCHAINFiles that make up the CA trust chain[]
tlsserverkeyOptionalORION_TLSSERVERKEYPrivate key for the server TLS certificate"tls-server-key.pem"
tlsservertrustOptionalORION_TLSSERVERTRUSTTLS trust mode for the server"tofu"
tlsknownclientsOptionalORION_TLSKNOWNCLIENTSTLS known clients for the server"tls-known-clients"
tlsclientcertOptionalORION_TLSCLIENTCERTClient TLS certificate"tls-client-cert.pem"
tlsclientchainOptionalORION_TLSCLIENTCHAINFiles that make up the CA trust chain[]
tlsclientkeyOptionalORION_TLSCLIENTKEYPrivate key for the client TLS certificate"tls-client-key.pem"
tlsclienttrustOptionalORION_TLSCLIENTTRUSTTLS trust mode for the client"ca-or-tofu"
tlsknownserversOptionalORION_TLSKNOWNSERVERSTLS known servers for the client"tls-known-servers"
clientconnectiontlsOptionalORION_CLIENTCONNECTIONTLSTLS status options"off"
clientconnectiontlsservercertOptionalORION_CLIENTCONNECTIONTLSSERVERCERTServer TLS certificate"client-connection-tls-server-cert.pem"
clientconnectiontlsserverchainOptionalORION_CLIENTCONNECTIONTLSSERVERCHAINFiles that make up the CA trust chain[]
clientconnectiontlsserverkeyOptionalORION_CLIENTCONNECTIONTLSSERVERKEYPrivate key for the server TLS certificate"client-connection-tls-server-key.pem"
clientconnectionTlsServerTrustOptionalORION_CLIENTCONNECTIONTLSSERVERTRUSTTLS trust mode for the server"tofu"
clientconnectiontlsknownclientsOptionalORION_CLIENTCONNECTIONTLSKNOWNCLIENTSTLS known clients for the server"client-connection-tls-known-clients"

libsodiumpath

Depends on the operational system. Check the class LibSodiumSettings for more details.

alwayssendto

Specifies list of files containing public keys to include as a recipient for every transaction sent through the node (for example, for backup purposes). The specified public keys must be advertised by an Orion node on the network. That is, there must be an Orion node with the specified public keys included in the node publickeys list.

passwords

File contains one password per line. Include an empty line for keys that are not locked.