diff --git a/crates/arti/README.md b/crates/arti/README.md index d63ea0c59..6b9ca98a7 100644 --- a/crates/arti/README.md +++ b/crates/arti/README.md @@ -73,13 +73,13 @@ Tor Browser and instruct it to use that SOCKS port. #### Linux ``` -$ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 ./start-tor-browser.desktop +$ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 TOR_SKIP_CONTROLPORTTEST=1 ./start-tor-browser.desktop ``` #### OS X ``` -$ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 /path/to/Tor\ Browser/Contents/MacOS/firefox +$ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 TOR_SKIP_CONTROLPORTTEST=1 /path/to/Tor\ Browser/Contents/MacOS/firefox ``` #### Windows @@ -87,7 +87,7 @@ $ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 /path/to/Tor\ Browser/Contents/MacOS/fir 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" +C:\Windows\System32\cmd.exe /c "SET TOR_SKIP_LAUNCH=1&& SET TOR_SOCKS_PORT=9150&& TOR_SKIP_CONTROLPORTTEST=1&& START /D ^"C:\path\to\Tor Browser\Browser^" firefox.exe" ``` and `Start in` set to: @@ -99,13 +99,11 @@ and `Start in` set to: (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. +and bridges won't work (Arti doesn't support them yet), and neither will +any feature depending on Tor's control-port protocol. Features not depending +on the control-port such as the "New circuit for this site" button should +work. ## Compile-time features diff --git a/crates/arti/src/lib.rs b/crates/arti/src/lib.rs index 0d5474f2b..6bbe095ab 100644 --- a/crates/arti/src/lib.rs +++ b/crates/arti/src/lib.rs @@ -72,13 +72,13 @@ //! ### Linux //! //! ```text -//! $ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 ./start-tor-browser.desktop +//! $ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 TOR_SKIP_CONTROLPORTTEST=1 ./start-tor-browser.desktop //! ``` //! //! ### OS X //! //! ```text -//! $ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 /path/to/Tor\ Browser/Contents/MacOS/firefox +//! $ TOR_SKIP_LAUNCH=1 TOR_SOCKS_PORT=9150 TOR_SKIP_CONTROLPORTTEST=1 /path/to/Tor\ Browser/Contents/MacOS/firefox //! ``` //! //! ### Windows @@ -86,7 +86,7 @@ //! Create a shortcut with the `Target` set to: //! //! ```text -//! 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" +//! C:\Windows\System32\cmd.exe /c "SET TOR_SKIP_LAUNCH=1&& SET TOR_SOCKS_PORT=9150&& TOR_SKIP_CONTROLPORTTEST=1&& START /D ^"C:\path\to\Tor Browser\Browser^" firefox.exe" //! ``` //! //! and `Start in` set to: @@ -98,13 +98,11 @@ //! (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. +//! and bridges won't work (Arti doesn't support them yet), and neither will +//! any feature depending on Tor's control-port protocol. Features not depending +//! on the control-port such as the "New circuit for this site" button should +//! work. //! //! # Compile-time features //!