This guide will show you how to get started with running ORC! An ORC
node requires a configuration file to get up and running. The path to this
file is given to
orc when starting a node.
orc --config path/to/orc.config
If a configuration file is not supplied, a minimal default configuration is
automatically created and used, which will generate everything needed to run.
All of this data will be created and stored in
The location to write the PID file for the daemon.
Path to private key file to use for identity and encryption of private data.
The path to read (or create on first run), the file that contains the unique salt used for key derivation and the initialization vector user for the encryption of secrets. Losing or destroying this file will lose access to your node and prevent decryption of files. Back it up offline!
The path to the directory to instruct Tor to use for storing hidden service keys and other information.
Sets the virtual port number for your node's RPC onion service.
Sets the local port to bind the node's RPC service.
More detailed logging of messages sent and received. Useful for debugging.
Path to write the daemon's log file. Log file will rotate either every 24 hours or when it exceeds 10MB, whichever happens first.
Maximum number of rotated log files to keep.
Add a map of network bootstrap nodes to this section to use for discovering other peers. Default configuration should come with a list of known and trusted contacts.
Sets the hostname or IP address to which the bridge service should be bound. It is important to set this value to a loopback address if authentication is disabled to prevent others from accessing your objects.
Set the TCP port to which the bridge service's HTTP API should be bound.
Redirects the Tor process log output through ORC's logger for the purpose of debugging.
Defines the verbosity level of the Tor process logging. Valid options are:
Sets the SOCKS proxy type for Tor communication. This currently defaults to 4 until this ticket is closed.
Path to the file that contains the identity nonce.
Path to the file that contains the identity proof.
Path to store the encrypted 2FA auth secret for the API.
Path to passphrase file to unlock ORC non-interactively.
Path to store the encrypted slices database. This contains data stored for others.
Path to store local encrypted pointer information for the API.
File path to track known peer information.
Number of leading zeroes in hashcash stamps for storing blobs. Used for mitigating spam.