vincenzopalazzo
/
arti
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'todos' into 'main' 

Add config paths table in arti docs

See merge request tpo/core/arti!386
This commit is contained in:
Nick Mathewson 2022-03-04 22:19:44 +00:00
parent 64fa8ea77d ef21559df1
commit 8231e70288
2 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/arti/README.md
View File

@ -29,8 +29,13 @@ The only currently implemented subcommand is `arti proxy`; try
## Configuration
By default, `arti` looks for its configuration files in a
platform-dependent location. That's `~/.config/arti/arti.toml` on
Unix. (TODO document OSX and Windows.)
platform-dependent location.
| OS | Configuration File |
|---------|----------------------------------------------------|
| Unix | `~/.config/arti/arti.toml` |
| macOS | `~/Library/Application Support/arti/arti.toml` |
| Windows | `\Users\<USERNAME>\AppData\Roaming\arti\arti.toml` |
The configuration file is TOML. (We do not guarantee its stability.)
For an example see [`arti_defaults.toml`](./arti_defaults.toml).
@ -42,6 +47,7 @@ For an example see [`arti_defaults.toml`](./arti_defaults.toml).
`async-std`: Use the async-std runtime library as our backend.
This feature has no effect unless building with `--no-default-features`
to disable tokio.
`native-tls` -- Build with support for the `native_tls` TLS
backend. (default)

11
crates/arti/src/main.rs
View File

@ -27,8 +27,13 @@
//! # Configuration
//!
//! By default, `arti` looks for its configuration files in a
//! platform-dependent location. That's `~/.config/arti/arti.toml` on
//! Unix. (TODO document OSX and Windows.)
//! platform-dependent location.
//!
//! | OS | Configuration File |
//! |---------|----------------------------------------------------|
//! | Unix | `~/.config/arti/arti.toml` |
//! | macOS | `~/Library/Application Support/arti/arti.toml` |
//! | Windows | `\Users\<USERNAME>\AppData\Roaming\arti\arti.toml` |
//!
//! The configuration file is TOML. (We do not guarantee its stability.)
//! For an example see [`arti_defaults.toml`](./arti_defaults.toml).
@ -40,7 +45,7 @@
//! `async-std`: Use the async-std runtime library as our backend.
//! This feature has no effect unless building with `--no-default-features`
//! to disable tokio.
//!
//! `native-tls` -- Build with support for the `native_tls` TLS
//! backend. (default)
//!