Expand description
Configuration for the Arti command line application
Re-exportsΒ§
use derive_deftly::Deftly;πuse tor_basic_utils::ByteQty;πuse tor_config_path::CfgPath;πuse crate::onion_proxy::OnionServiceProxyConfigBuilder;πuse crate::onion_proxy::OnionServiceProxyConfigMap;πuse crate::onion_proxy::OnionServiceProxyConfigMapBuilder;πpub use crate::rpc::RpcConfig;pub use crate::rpc::RpcConfigBuilder;pub use crate::rpc::listener::RpcListenerSetConfig;pub use crate::rpc::listener::RpcListenerSetConfigBuilder;use arti_client::TorClientConfig;πuse tor_config::define_list_builder_accessors;πuse crate::LoggingConfig;πuse crate::LoggingConfigBuilder;πuse tor_config::derive::prelude::*;π
StructsΒ§
- Application
Config - Structure to hold our application configuration options
- Application
Config Builder - A builder to create an instance of
ApplicationConfig. - Arti
Config - 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
artiso that other applications can parse and use them, if desired. If youβre only embedding arti viaarti-client, and you donβt want to use Artiβs configuration format, usearti_client::TorClientConfiginstead. - Arti
Config Builder - A builder to create an instance of
ArtiConfig. - Arti
Storage Config - Configuration for arti-specific storage locations.
- Arti
Storage Config Builder - A builder to create an instance of
ArtiStorageConfig. - Listen π
- Specification of (possibly) something to listen on (eg, a port, or some addresses/ports)
- Metrics
Config π - Configuration for exporting metrics (eg, perf data)
- Metrics
Config πBuilder - A builder to create an instance of
MetricsConfig. - Proxy
Config - Configuration for one or more proxy listeners.
- Proxy
Config Builder - A builder to create an instance of
ProxyConfig. - System
Config - Configuration for system resources used by Tor.
- System
Config Builder - A builder to create an instance of
SystemConfig.
EnumsΒ§
- Config
Build πError - 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.
- DEFAULT_
RECV_ πBUF_ SIZE - See
ProxyConfig::socket_recv_buf_size. - DEFAULT_
SEND_ πBUF_ SIZE - See
ProxyConfig::socket_send_buf_size.
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Β§
- Arti
Combined Config - Convenience alias for the config for a whole
artiprogram