mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-04-02 05:23:18 +00:00
restructure to account for new theme, add new build process, update readme
This commit is contained in:
84
docs/source/misc-guides/tor-os/android.rst
Normal file
84
docs/source/misc-guides/tor-os/android.rst
Normal file
@@ -0,0 +1,84 @@
|
||||
.. _tor-android:
|
||||
|
||||
**********************
|
||||
Running Tor on Android
|
||||
**********************
|
||||
|
||||
Some apps, such as Tor Browser or Cups Messenger, have Tor built in. They do not require additional software or configurations to utilize Tor. Most apps, however, do not have Tor built in. They require an app called Orbot to be installed in order to utilize Tor.
|
||||
|
||||
.. youtube:: b__mVfN-BP8
|
||||
|
||||
Running Orbot
|
||||
-------------
|
||||
|
||||
Orbot is a system wide proxy for your Android or Graphene device that enables communications over Tor.
|
||||
|
||||
1. Download Orbot from the `Play Store <https://play.google.com/store/apps/details?id=org.torproject.android>`_ , or from `F-Droid <https://f-droid.org/packages/org.torproject.android>`_.
|
||||
|
||||
2. Launch Orbot.
|
||||
|
||||
3. Open the kebab menu in the upper right hand corner and select `Settings`:
|
||||
|
||||
.. figure:: /_static/images/tor/orbot_menu.png
|
||||
:width: 50%
|
||||
:alt: Orbot menu
|
||||
|
||||
4. Make sure the options for `Start Orbot on Boot` and `Allow Background Starts` are checked:
|
||||
|
||||
.. figure:: /_static/images/tor/orbot_settings.png
|
||||
:width: 50%
|
||||
:alt: Orbot settings
|
||||
|
||||
5. Go back, and tap start:
|
||||
|
||||
.. figure:: /_static/images/tor/orbot_start.png
|
||||
:width: 50%
|
||||
:alt: Orbot start
|
||||
|
||||
6. Orbot will start up the Tor service. Once complete, you will see:
|
||||
|
||||
.. figure:: /_static/images/tor/orbot_started.png
|
||||
:width: 50%
|
||||
:alt: Orbot started
|
||||
|
||||
7. That's it. Certain apps, such as Firefox or DuckDuckGo will now just work. Other apps, however, require that Orbot be running VPN mode.
|
||||
|
||||
Orbot VPN mode
|
||||
--------------
|
||||
|
||||
To utilize Tor, most apps require that Orbot be running in VPN mode.
|
||||
|
||||
1. Disable Private DNS on your device. To do so, navigate to:
|
||||
|
||||
``Settings > Network & Internet > Advanced > Private DNS > Off``
|
||||
|
||||
.. figure:: /_static/images/tor/private_dns_off.png
|
||||
:width: 50%
|
||||
:alt: Private DNS off
|
||||
|
||||
Toggle Private DNS to "off"
|
||||
|
||||
2. Launch Orbot and toggle VPN Mode on:
|
||||
|
||||
.. figure:: /_static/images/tor/orbot_vpn.png
|
||||
:width: 50%
|
||||
:alt: Orbot vpn mode
|
||||
|
||||
Toggle VPN Mode to "on"
|
||||
|
||||
Under `Tor-Enabled Apps`, click the gear icon and add apps you want to utilize Tor.
|
||||
|
||||
.. figure:: /_static/images/tor/orbot_apps.png
|
||||
:width: 50%
|
||||
:alt: Orbot apps
|
||||
|
||||
Examples of applications that need this feature are:
|
||||
|
||||
- Bitwarden
|
||||
- Zap
|
||||
- Zeus
|
||||
|
||||
You can also add the following browsers to the Tor-Enabled Apps list to easily access Tor addresses (`.onion` URLs):
|
||||
|
||||
- Chrome
|
||||
- Brave
|
||||
18
docs/source/misc-guides/tor-os/index.rst
Normal file
18
docs/source/misc-guides/tor-os/index.rst
Normal file
@@ -0,0 +1,18 @@
|
||||
.. _running-tor:
|
||||
|
||||
***********
|
||||
Running Tor
|
||||
***********
|
||||
|
||||
Running Tor on your phone or computer enables apps that are not Tor-enabled to communicate over Tor.
|
||||
|
||||
Select your operating system to get started:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
MacOS<mac>
|
||||
Windows<windows>
|
||||
Linux<linux>
|
||||
Android<android>
|
||||
iOS<ios>
|
||||
9
docs/source/misc-guides/tor-os/ios.rst
Normal file
9
docs/source/misc-guides/tor-os/ios.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
.. _tor-ios:
|
||||
|
||||
*********************
|
||||
Setting up Tor on iOS
|
||||
*********************
|
||||
|
||||
Unfortunately, Apple does not allow tor to be run natively on iOS. This leaves 2 options for iOS users:
|
||||
|
||||
You can use Start9's own Consulate Browser, which is available `here <https://apps.apple.com/us/app/start9-consulate-browser/id1528124570>`_, or you can select another Tor Browser by searching the `App Store <https://www.apple.com/us/search/onion-browser?src=serp>`_.
|
||||
15
docs/source/misc-guides/tor-os/linux.rst
Normal file
15
docs/source/misc-guides/tor-os/linux.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
.. _tor-linux:
|
||||
|
||||
********************
|
||||
Running Tor on Linux
|
||||
********************
|
||||
|
||||
For Debian and Debian-based systems, such as Ubuntu, Mint, etc.
|
||||
|
||||
#. Install the Tor proxy service to your system. To do so, open your terminal and run the following command:
|
||||
|
||||
.. code-block::
|
||||
|
||||
sudo apt update && sudo apt install tor
|
||||
|
||||
#. That's it! Your Linux machine is now setup to natively use Tor.
|
||||
98
docs/source/misc-guides/tor-os/mac.rst
Normal file
98
docs/source/misc-guides/tor-os/mac.rst
Normal file
@@ -0,0 +1,98 @@
|
||||
.. _tor-mac:
|
||||
|
||||
********************
|
||||
Running Tor on MacOS
|
||||
********************
|
||||
|
||||
For macOS running on ARM chips (ie. newer macs):
|
||||
================================================
|
||||
|
||||
Install Homebrew
|
||||
----------------
|
||||
|
||||
.. warning:: macOS Homebrew running natively on M1/Apple Silicon/ARM has partial functionality. Therefore, some additional steps are needed to setup Homebrew.
|
||||
|
||||
#. Open a command line editor (Terminal), and run the following commands:
|
||||
|
||||
.. code-block::
|
||||
|
||||
softwareupdate --install-rosetta
|
||||
arch -x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
|
||||
|
||||
Install Tor
|
||||
-----------
|
||||
|
||||
.. warning:: If you have the Tor Browser open, close it and quit the application.
|
||||
|
||||
#. In the command line, install Tor:
|
||||
|
||||
.. code-block::
|
||||
|
||||
arch -x86_64 brew install tor
|
||||
|
||||
#. Then start Tor:
|
||||
|
||||
.. code-block::
|
||||
|
||||
arch -x86_64 brew services start tor
|
||||
|
||||
This will start Tor and ensure that it is always running, even after a restart. See the `Tor Project <https://2019.www.torproject.org/docs/tor-doc-osx.html.en>`_ for more details.
|
||||
|
||||
For macOS Big Sur/Catalina:
|
||||
===========================
|
||||
|
||||
Install Homebrew
|
||||
----------------
|
||||
|
||||
1. If you do not have Homebrew installed, follow the installation instructions `here <https://brew.sh/>`_.
|
||||
|
||||
TLDR: Open the command line editor (Terminal) and paste the following line:
|
||||
|
||||
.. code-block::
|
||||
|
||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
|
||||
|
||||
2. You will be prompted for your system password before installation; proceed with entering your password:
|
||||
|
||||
.. figure:: /_static/images/tor/install_homebrew.png
|
||||
:width: 80%
|
||||
:alt: Homebrew installation
|
||||
|
||||
Enter your password
|
||||
|
||||
3. You will be notified which directories Homebrew is going to create, hit :code:`RETURN`:
|
||||
|
||||
.. figure:: /_static/images/tor/install_homebrew1.png
|
||||
:width: 80%
|
||||
:alt: Homebrew installation
|
||||
|
||||
Homebrew creates the directories and downloads any other files it needs e.g. “Command Line Tool for Xcode” and “Homebrew”.
|
||||
|
||||
Wait a few minutes while it downloads and installs what it needs.
|
||||
|
||||
.. warning:: Surprisingly, Homebrew uses Google Analytics to collect anonymous usage data. You can deselect the option to share usage data by `opting out <https://docs.brew.sh/Analytics#opting-out>`_.
|
||||
|
||||
Install Tor
|
||||
-----------
|
||||
|
||||
.. warning:: If you have the Tor Browser open, close it and quit the application.
|
||||
|
||||
#. In the command line, install Tor:
|
||||
|
||||
.. code-block::
|
||||
|
||||
brew install tor
|
||||
|
||||
Once it is finished you have the following options:
|
||||
|
||||
.. figure:: /_static/images/tor/install_tor.png
|
||||
:width: 80%
|
||||
:alt: Tor installation
|
||||
|
||||
#. Then run Tor with:
|
||||
|
||||
.. code-block::
|
||||
|
||||
brew services start tor
|
||||
|
||||
This will start Tor and ensure that it is always running, even after a restart. See the `Tor Project <https://2019.www.torproject.org/docs/tor-doc-osx.html.en>`_ for more details.
|
||||
62
docs/source/misc-guides/tor-os/windows.rst
Normal file
62
docs/source/misc-guides/tor-os/windows.rst
Normal file
@@ -0,0 +1,62 @@
|
||||
.. _tor-windows:
|
||||
|
||||
**********************
|
||||
Running Tor on Windows
|
||||
**********************
|
||||
|
||||
#. First, you need to install the Tor proxy service to your system. Unfortunately, `torproject.org` no longer publishes a standalone Tor binary for Windows, so the recommended way to get it is with the Tor Browser Bundle. You can download it `here <https://www.torproject.org/download/>`_.
|
||||
|
||||
.. figure:: /_static/images/tor/tor_download_windows.png
|
||||
:width: 80%
|
||||
:alt: Tor download
|
||||
|
||||
Download Tor for Windows
|
||||
|
||||
#. Once it is downloaded, go ahead and run the installer. If you want to install the program outside of your user directory, you will have to right click and select `Run as Administrator`.
|
||||
|
||||
#. Once you have selected a language, you should see a menu like this:
|
||||
|
||||
.. figure:: /_static/images/tor/tor_windows_install.png
|
||||
:width: 80%
|
||||
:alt: Tor install wizard
|
||||
|
||||
Note Tor destination folder when installing
|
||||
|
||||
#. It does not matter where you set the destination folder; however, you need to make note of it for later. Go ahead and finish the installation.
|
||||
|
||||
#. Now you want to set up Tor to run as a service: to run in the background and keep itself running so you don’t have to worry about it again. To do so, you need to open your Command Prompt as an administrator.
|
||||
|
||||
* In Windows 10, you can simply type ``cmd`` in the Windows search bar, right click on the first result, and select `Run as Administrator`.
|
||||
|
||||
#. Once it opens, you can run the following commands, inserting your destination folder (from above) in place of ``<PATH TO>``:
|
||||
|
||||
.. code-block::
|
||||
|
||||
sc create tor start= auto binPath= "<PATH TO>\Browser\TorBrowser\Tor\tor.exe -nt-service"
|
||||
|
||||
.. code-block::
|
||||
|
||||
sc start tor
|
||||
|
||||
.. note:: If you get the error "Access denied," please ensure you are running the command prompt in Administrator mode. You can tell because the prompt will show C:\\Users\\YOUR-USERNAME> if you are NOT in admin mode, and it will show C:\\WINDOWS\\system32 if you ARE in admin mode.
|
||||
|
||||
.. note:: If you get the error "The specified service already exists," complete the following steps:
|
||||
|
||||
1. Run the command:
|
||||
|
||||
.. code-block::
|
||||
|
||||
sc delete tor
|
||||
|
||||
1. Uninstall the Tor Browser, following `these steps <https://tb-manual.torproject.org/uninstalling/>`_.
|
||||
2. Begin this guide again from the beginning.
|
||||
|
||||
#. When you run this, it should look something like this:
|
||||
|
||||
.. figure:: /_static/images/tor/tor_windows_terminal.png
|
||||
:width: 80%
|
||||
:alt: Tor windows terminal
|
||||
|
||||
Replace highlighted section with noted destination folder
|
||||
|
||||
#. That's it! Your Windows computer is now setup to natively use Tor.
|
||||
Reference in New Issue
Block a user