Git-Mirrors/onionshare
1
0
Fork 0
mirror of https://github.com/onionshare/onionshare.git synced 2024-12-24 23:09:42 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated tor docs for 2.3

Browse Source
This commit is contained in:
Micah Lee 2020-11-15 14:42:16 -08:00
parent ca04137ec7
commit 766144649e
No known key found for this signature in database
GPG Key ID: 403C2657CD994F73
1 changed files with 18 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/source/tor.rst
View File

@ -5,23 +5,23 @@ Pick a way to connect OnionShare to Tor by clicking the "⚙" icon in the bottom
.. image:: _static/screenshots/settings.png .. image:: _static/screenshots/settings.png
Use the Tor bundled with OnionShare Use the ``tor`` bundled with OnionShare
----------------------------------- ---------------------------------------
This is the default, simplest and most reliable way that OnionShare connects to Tor. This is the default, simplest and most reliable way that OnionShare connects to Tor.
For this reason, it's recommended for most users. For this reason, it's recommended for most users.
When you open OnionShare, it launches an already configured Tor process in the background OnionShare to use. When you open OnionShare, it launches an already configured ``tor`` process in the background for OnionShare to use.
It doesn't interfere with other Tor processes on your computer, so you can use the Tor Browser or the system Tor on their own. It doesn't interfere with other ``tor`` processes on your computer, so you can use the Tor Browser or the system ``tor`` on their own.
Attempt auto-configuration with Tor Browser Attempt auto-configuration with Tor Browser
------------------------------------------------ -------------------------------------------
If you have `downloaded the Tor Browser <https://www.torproject.org>`_ and don't want two Tor processes running, you can use the Tor process from the Tor browser. If you have `downloaded the Tor Browser <https://www.torproject.org>`_ and don't want two ``tor`` processes running, you can use the ``tor`` process from the Tor Browser.
Keep in mind you need to keep Tor Browser open in the background while you're using OnionShare for this to work. Keep in mind you need to keep Tor Browser open in the background while you're using OnionShare for this to work.
Using a system Tor in Windows Using a system ``tor`` in Windows
----------------------------- ---------------------------------
This is fairly advanced. You'll need to know how edit plaintext files and do stuff as an administrator. This is fairly advanced. You'll need to know how edit plaintext files and do stuff as an administrator.
@ -31,7 +31,7 @@ Rename the extracted folder with ``Data`` and ``Tor`` in it to ``tor-win32``.
Make up a control port password. Make up a control port password.
(Using 7 words in a sequence like ``comprised stumble rummage work avenging construct volatile`` is a good idea for a password.) (Using 7 words in a sequence like ``comprised stumble rummage work avenging construct volatile`` is a good idea for a password.)
Now open a command prompt (cmd) as an administrator, and use ``tor.exe --hash-password`` to generate a hash of your password. For example:: Now open a command prompt (``cmd``) as an administrator, and use ``tor.exe --hash-password`` to generate a hash of your password. For example::
cd "C:\Program Files (x86)\tor-win32\Tor" cd "C:\Program Files (x86)\tor-win32\Tor"
tor.exe --hash-password "comprised stumble rummage work avenging construct volatile" tor.exe --hash-password "comprised stumble rummage work avenging construct volatile"
@ -41,22 +41,23 @@ The hashed password output is displayed after some warnings (which you can ignor
Now create a new text file at ``C:\Program Files (x86)\tor-win32\torrc`` and put your hashed password output in it, replacing the ``HashedControlPassword`` with the one you just generated:: Now create a new text file at ``C:\Program Files (x86)\tor-win32\torrc`` and put your hashed password output in it, replacing the ``HashedControlPassword`` with the one you just generated::
ControlPort 9051 ControlPort 9051
HashedControlPassword (The numbers you generate from the password you picked above) HashedControlPassword (the hash you generate from the password you picked above)
In your administrator command prompt, install Tor as a service using the appropriate ``torrc`` file you just created (as described in `<https://2019.www.torproject.org/docs/faq.html.en#NTService>`_). Like this:: In your administrator command prompt, install ``tor`` as a service using the appropriate ``torrc`` file you just created (as described in `<https://2019.www.torproject.org/docs/faq.html.en#NTService>`_). Like this::
tor.exe --service install -options -f "C:\Program Files (x86)\tor-win32\torrc" tor.exe --service install -options -f "C:\Program Files (x86)\tor-win32\torrc"
You are now running a system Tor process in Windows! You are now running a system ``tor`` process in Windows!
Open OnionShare. Under "How should OnionShare connect to Tor?" choose "Connect using control port", and set Open OnionShare and click the "⚙" icon in it.
Under "How should OnionShare connect to Tor?" choose "Connect using control port", and set
"Control port" to ``127.0.0.1`` and "Control port" to ``127.0.0.1`` and
"Port" to ``9051``. "Port" to ``9051``.
Under "Tor authentication settings" choose "Password" and set the password to the control port password you picked above Under "Tor authentication settings" choose "Password" and set the password to the control port password you picked above
Click the "Test Connection to Tor" button. Click the "Test Connection to Tor" button.
If all goes well, you should see "Connected to the Tor controller". If all goes well, you should see "Connected to the Tor controller".
Using the system's Tor in macOS Using a system ``tor`` in macOS
------------------------------- -------------------------------
First, install `Homebrew <https://brew.sh/>`_ if you don't already have it. Then, install Tor:: First, install `Homebrew <https://brew.sh/>`_ if you don't already have it. Then, install Tor::
@ -82,18 +83,12 @@ Click the "Test Connection to Tor" button.
If all goes well, you should see "Connected to the Tor controller". If all goes well, you should see "Connected to the Tor controller".
Using the system's Tor in Linux Using a system ``tor`` in Linux
------------------------------- -------------------------------
First, install the Tor package. If you're using Debian, Ubuntu, or a similar Linux distro, It is recommended to use the Tor Project's `official repository <https://2019.www.torproject.org/docs/debian.html.en>`_. For example, in Ubuntu 20.04:: First, install the ``tor`` package. If you're using Debian, Ubuntu, or a similar Linux distro, It is recommended to use the Tor Project's `official repository <https://support.torproject.org/apt/tor-deb-repo/>`_.
sudo su -c "echo 'deb https://deb.torproject.org/torproject.org focal main' > /etc/apt/sources.list.d/torproject.list" Next, add your user to the group that runs the ``tor`` process (in the case of Debian and Ubuntu, ``debian-tor``) and configure OnionShare to connect to your system ``tor``'s control socket file.
curl https://deb.torproject.org/torproject.org/A3C4F0F979CAA22CDBA8F512EE8CBC9E886DDD89.asc | gpg --import
gpg --export A3C4F0F979CAA22CDBA8F512EE8CBC9E886DDD89 | sudo apt-key add -
sudo apt-get update
sudo apt-get install -y tor deb.torproject.org-keyring
Next, add your user to the group that runs the Tor process (in the case of Debian and Ubuntu, ``debian-tor``) and configure OnionShare to connect to your system Tor's control socket file.
Add your user to the ``debian-tor`` group by running this command (replace ``username`` with your actual username):: Add your user to the ``debian-tor`` group by running this command (replace ``username`` with your actual username)::