Skip to main content

Module cfg

Module cfg 

Source
Expand description

Configuration for the Arti command line application

Re-exports§

pub use crate::rpc::RpcConfig;
pub use crate::rpc::RpcConfigBuilder;

Structs§

ApplicationConfig
Structure to hold our application configuration options
ApplicationConfigBuilder
A builder to create an instance of ApplicationConfig.
ArtiConfig
Structure to hold Arti’s configuration options, whether from a configuration file or the command line. These options are declared in a public crate outside of arti so that other applications can parse and use them, if desired. If you’re only embedding arti via arti-client, and you don’t want to use Arti’s configuration format, use arti_client::TorClientConfig instead.
ArtiConfigBuilder
A builder to create an instance of ArtiConfig.
ArtiStorageConfig
Configuration for arti-specific storage locations.
ArtiStorageConfigBuilder
A builder to create an instance of ArtiStorageConfig.
Listen 🔒
Specification of (possibly) something to listen on (eg, a port, or some addresses/ports)
MetricsConfig
Configuration for exporting metrics (eg, perf data)
MetricsConfigBuilder
A builder to create an instance of MetricsConfig.
PrometheusConfig
Configuration for one or more proxy listeners.
PrometheusConfigBuilder
A builder to create an instance of PrometheusConfig.
ProxyConfig
Configuration for one or more proxy listeners.
ProxyConfigBuilder
A builder to create an instance of ProxyConfig.
RpcListenerSetConfig
Configuration for a single source of connect points to use when configuring Arti as an RPC server.
RpcListenerSetConfigBuilder
A builder to create an instance of RpcListenerSetConfig.
SystemConfig
Configuration for system resources used by Tor.
SystemConfigBuilder
A builder to create an instance of SystemConfig.

Enums§

ConfigBuildError 🔒
An error related to an option passed to Arti via a configuration builder.

Constants§

ARTI_EXAMPLE_CONFIG
Example file demonstrating our configuration and the default options.

Functions§

default_max_files 🔒
Return the default maximum number of file descriptors to launch with.
default_port_info_file 🔒
Return the default ports_info_file location.

Type Aliases§

ArtiCombinedConfig
Convenience alias for the config for a whole arti program