READMEs: Run maint/readmes (to update READMEs from lib.rs)
This commit is contained in:
parent
1f78b781f1
commit
52d9b8103a
|
@ -25,7 +25,8 @@ right now your best bet is probably to spawn the
|
||||||
[`arti` CLI](https://tpo.pages.torproject.net/core/doc/rust/arti/index.html)
|
[`arti` CLI](https://tpo.pages.torproject.net/core/doc/rust/arti/index.html)
|
||||||
SOCKS proxy,
|
SOCKS proxy,
|
||||||
as a subprocess.
|
as a subprocess.
|
||||||
We don't yet offer an API that would be nice to expose via FFI.
|
We don't yet offer an API that would be nice to expose via FFI;
|
||||||
|
we intend to add this in the future.
|
||||||
|
|
||||||
### ⚠ Warnings ⚠
|
### ⚠ Warnings ⚠
|
||||||
|
|
||||||
|
|
|
@ -14,10 +14,10 @@ It will listen on port 9150 by default,
|
||||||
but you can override this in the configuration.
|
but you can override this in the configuration.
|
||||||
You can direct programs to connect via that SOCKS port,
|
You can direct programs to connect via that SOCKS port,
|
||||||
and their connections will be anonymized via Tor.
|
and their connections will be anonymized via Tor.
|
||||||
NB you might not want to run a conventional web browser this way.
|
Note: you might not want to run a conventional web browser this way.
|
||||||
Browsers leak much private information.
|
Browsers leak much private information.
|
||||||
To browse the web anonymously,
|
To browse the web anonymously,
|
||||||
we recommend using [`Tor Browser`](https://www.torproject.org/download/).
|
we recommend [using Tor Browser](#using-arti-with-tor-browser).
|
||||||
|
|
||||||
Arti is still advancing rapidly; we are adding features and eventually
|
Arti is still advancing rapidly; we are adding features and eventually
|
||||||
we hope it will be able to replace C Tor.
|
we hope it will be able to replace C Tor.
|
||||||
|
@ -54,6 +54,59 @@ More detailed information about for the individual fields is available in the do
|
||||||
for the Rust APIs [`ApplicationConfigBuilder`] and
|
for the Rust APIs [`ApplicationConfigBuilder`] and
|
||||||
[`TorClientConfigBuilder`](arti_client::config::TorClientConfigBuilder).
|
[`TorClientConfigBuilder`](arti_client::config::TorClientConfigBuilder).
|
||||||
|
|
||||||
|
## Using Arti with Tor Browser
|
||||||
|
|
||||||
|
It is possible to hook up Arti with
|
||||||
|
[Tor Browser](https://www.torproject.org/download/).
|
||||||
|
|
||||||
|
To do so, we will launch arti independently from Tor Browser. Build arti with
|
||||||
|
`cargo build --release`. After that launch it with some basic
|
||||||
|
configuration parameters:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ./target/release/arti proxy -l debug -p 9150
|
||||||
|
```
|
||||||
|
|
||||||
|
This will ensure that arti sets its SOCKS port on 9150. Now we need to launch
|
||||||
|
Tor Browser and instruct it to use that SOCKS port.
|
||||||
|
|
||||||
|
#### Linux
|
||||||
|
|
||||||
|
```
|
||||||
|
$ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 ./start-tor-browser.desktop
|
||||||
|
```
|
||||||
|
|
||||||
|
#### OS X
|
||||||
|
|
||||||
|
```
|
||||||
|
$ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 /path/to/Tor\ Browser/Contents/MacOS/firefox
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Windows
|
||||||
|
|
||||||
|
Create a shortcut with the `Target` set to:
|
||||||
|
|
||||||
|
```
|
||||||
|
C:\Windows\System32\cmd.exe /c "SET TOR_SKIP_LAUNCH=1&& SET TOR_SOCKS_PORT=9150&& START /D ^"C:\path\to\Tor Browser\Browser^" firefox.exe"
|
||||||
|
```
|
||||||
|
|
||||||
|
and `Start in` set to:
|
||||||
|
|
||||||
|
```
|
||||||
|
"C:\path\to\Tor Browser\Browser"
|
||||||
|
```
|
||||||
|
|
||||||
|
(You may need to adjust the actual path to wherever you have put your Tor
|
||||||
|
Browser.)
|
||||||
|
|
||||||
|
When you start Tor browser, it will give you a big red error page because
|
||||||
|
Arti isn't offering it a control port interface. But it will still work!
|
||||||
|
Try [check.torproject.org](https://check.torproject.org/) to be sure.
|
||||||
|
|
||||||
|
The resulting Tor Browser should be using arti. Note that onion services
|
||||||
|
won't work (Arti doesn't have them yet), and neither will any feature
|
||||||
|
depending on Tor's control-port protocol.
|
||||||
|
|
||||||
## Compile-time features
|
## Compile-time features
|
||||||
|
|
||||||
### Additive features
|
### Additive features
|
||||||
|
|
Loading…
Reference in New Issue