haveno-network/haveno-core
haveno-network/haveno-core
1
0
Fork 1
Code Issues 4 Pull requests Projects 5 Releases 1 Packages Wiki Activity Actions

cleanup external tor docs

Browse source
This commit is contained in:
woodser 2025-03-07 07:45:17 -05:00 committed by GitHub
parent 6b567b94f2
commit a53026be8a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 23 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
docs/external-tor-usage.md
View file

@ -1,13 +1,13 @@
# **Using External `tor` with `Haveno`** # **Using External `tor` with Haveno**
## *[How to Install little-t-`tor` for Your Platform?](https://support.torproject.org/little-t-tor/#little-t-tor_install-little-t-tor)* ## [How to Install little-t-`tor` for Your Platform](https://support.torproject.org/little-t-tor/#little-t-tor_install-little-t-tor)
The following `tor` installation instructions have are presented here for convenience. The following `tor` installation instructions are presented here for convenience.
* **For the most complete, up-to-date & authoritative steps, readers are encouraged to refer the [Tor Project's Official Homepage](https://www.torproject.org) linked in the header** * **For the most complete, up-to-date & authoritative steps, readers are encouraged to refer to the [Tor Project's Official Homepage](https://www.torproject.org) linked in the header**
* **Notes:** * **Notes:**
For optimum compatibility with `Haveno` the running `tor` version should match that of the internal `Haveno` `tor` version For optimum compatibility with Haveno the running `tor` version should match that of the internal Haveno `tor` version
For best results, use a version of `tor` which supports the [Onion Service Proof of Work](https://onionservices.torproject.org/technology/security/pow) (`PoW`) mechanism For best results, use a version of `tor` which supports the [Onion Service Proof of Work](https://onionservices.torproject.org/technology/security/pow) (`PoW`) mechanism
* (IE: `GNU` build of `tor`) * (IE: `GNU` build of `tor`)
@ -52,9 +52,9 @@ The following `tor` installation instructions have are presented here for conven
### Debian / Ubuntu ### Debian / Ubuntu
* *Do **not** use the packages in Ubuntu's universe. In the past they have not reliably been updated. That means you could be missing stability and security fixes.* * *Do **not** use the packages in Ubuntu's universe. In the past they have not reliably been updated. That means you could be missing stability and security fixes.*
* Configure the [Official `Tor` Package Repository](https://deb.torproject.org/torproject.org) * Configure the [Official Tor Package Repository](https://deb.torproject.org/torproject.org)
Enable the [Official `Tor` Package Repository](https://deb.torproject.org/torproject.org) following these [instructions](https://support.torproject.org/apt/tor-deb-repo/) Enable the [Official Tor Package Repository](https://deb.torproject.org/torproject.org) following these [instructions](https://support.torproject.org/apt/tor-deb-repo/)
#### Package Installation #### Package Installation
```shell ```shell
@ -62,9 +62,9 @@ The following `tor` installation instructions have are presented here for conven
``` ```
### Fedora ### Fedora
* Configure the [Official `Tor` Package Repository](https://rpm.torproject.org/fedora) * Configure the [Official Tor Package Repository](https://rpm.torproject.org/fedora)
Enable the [Official `Tor` Package Repository](https://rpm.torproject.org/fedora) by following these [instructions](https://support.torproject.org/rpm/tor-rpm-install) Enable the [Official Tor Package Repository](https://rpm.torproject.org/fedora) by following these [instructions](https://support.torproject.org/rpm/tor-rpm-install)
#### Package Installation #### Package Installation
``` ```
@ -116,7 +116,7 @@ $ tor
### Windows ### Windows
#### Download #### Download
* Download the `Windows Expert Bundle` from the [Official `Tor` Project's Download page](https://www.torproject.org/download/tor) * Download the `Windows Expert Bundle` from the [Official Tor Project's Download page](https://www.torproject.org/download/tor)
#### Extract #### Extract
* Extract Archive to Disk * Extract Archive to Disk
@ -148,7 +148,7 @@ PS C:\Tor\> sc create tor start=auto binPath="<PATH TO>\Tor\tor.exe -nt-service"
PS C:\Tor\> sc start tor PS C:\Tor\> sc start tor
``` ```
### ***Configuring `tor`via `torrc`*** ## Configuring `tor` via `torrc`
#### [I'm supposed to "edit my torrc". What does that mean?](https://support.torproject.org/tbb/tbb-editing-torrc/) #### [I'm supposed to "edit my torrc". What does that mean?](https://support.torproject.org/tbb/tbb-editing-torrc/)
* Per the [Official Tor Project's support page](https://support.torproject.org/tbb/tbb-editing-torrc/): * Per the [Official Tor Project's support page](https://support.torproject.org/tbb/tbb-editing-torrc/):
* **WARNING:** Do **NOT** follow random advice instructing you to edit your torrc! Doing so can allow an attacker to compromise your security and anonymity through malicious configuration of your torrc. * **WARNING:** Do **NOT** follow random advice instructing you to edit your torrc! Doing so can allow an attacker to compromise your security and anonymity through malicious configuration of your torrc.
@ -161,7 +161,7 @@ PS C:\Tor\> sc start tor
Users are ***strongly*** encouraged to review both the [Official Tor Project's support page](https://support.torproject.org/tbb/tbb-editing-torrc/) as well as the [sample `torrc`](https://gitlab.torproject.org/tpo/core/tor/-/blob/HEAD/src/config/torrc.sample.in) before proceeding. Users are ***strongly*** encouraged to review both the [Official Tor Project's support page](https://support.torproject.org/tbb/tbb-editing-torrc/) as well as the [sample `torrc`](https://gitlab.torproject.org/tpo/core/tor/-/blob/HEAD/src/config/torrc.sample.in) before proceeding.
#### Enable `torControlPort` in `torrc` #### Enable `torControlPort` in `torrc`
In order for `Haveno` to use the `--torControlPort` option, it must be enabled and accessible. The most common way to do so is to edit the `torrc` fiel with a text editor to ensure that an entry for `ControlPort` followed by port number to listen on is present in the `torrc` file. In order for Haveno to use the `--torControlPort` option, it must be enabled and accessible. The most common way to do so is to edit the `torrc` fiel with a text editor to ensure that an entry for `ControlPort` followed by port number to listen on is present in the `torrc` file.
#### [Authentication](https://spec.torproject.org/control-spec/implementation-notes.html#authentication) #### [Authentication](https://spec.torproject.org/control-spec/implementation-notes.html#authentication)
Per the [Tor Control Protocol - Implementation Notes](https://spec.torproject.org/control-spec/implementation-notes.html): Per the [Tor Control Protocol - Implementation Notes](https://spec.torproject.org/control-spec/implementation-notes.html):
@ -197,17 +197,17 @@ HashedControlPassword 16:C01147DC5F4DA2346056668DD23522558D0E0C8B5CC88FE72EEBC51
### \* ***Optional*** \* ### \* ***Optional*** \*
#### [Set Up Your Onion Service](https://community.torproject.org/onion-services/setup) #### [Set Up Your Onion Service](https://community.torproject.org/onion-services/setup)
While not a *strict* requirement for use with `Haveno`, some users may wish to configure an [Onion Service](https://community.torproject.org/onion-services) While not a *strict* requirement for use with Haveno, some users may wish to configure an [Onion Service](https://community.torproject.org/onion-services)
* ***Only Required When Using The `Haveno` `--hiddenServiceAddress` Option*** * ***Only Required When Using The Haveno `--hiddenServiceAddress` Option***
Please see the [Official `Tor` Project's Documentation](https://community.torproject.org/onion-services/setup) for more information about configuration and usage of these services Please see the [Official Tor Project's Documentation](https://community.torproject.org/onion-services/setup) for more information about configuration and usage of these services
--- ---
## *`Haveno`'s `tor` Aware Options* ## Haveno's `tor` Aware Options
`Haveno` is a natively `tor` aware application and offers **many** flexible configuration options for use by privacy conscious users. Haveno is a natively `tor` aware application and offers **many** flexible configuration options for use by privacy conscious users.
While some are mutually exclusive, many are cross-applicable. While some are mutually exclusive, many are cross-applicable.
@ -257,7 +257,7 @@ Users are encouraged to experiment with options before use to determine which op
**Note:** **Note:**
`torrc`-entries which are critical to `Haveno`'s flawless operation (`torrc` options line, `torrc` option, ...) **can not** be overwritten `torrc`-entries which are critical to Haveno's flawless operation (`torrc` options line, `torrc` option, ...) **can not** be overwritten
* Expected Input Format: * Expected Input Format:
@ -274,11 +274,11 @@ Users are encouraged to experiment with options before use to determine which op
#### `--torrcOptions` #### `--torrcOptions`
* Function: * Function:
A list of `torrc`-entries to amend to `Haveno`'s `torrc` A list of `torrc`-entries to amend to Haveno's `torrc`
**Note:** **Note:**
*`torrc`-entries which are critical to `Haveno`'s flawless operation (`torrc` options line, `torrc` option, ...) can **not** be overwritten* *`torrc`-entries which are critical to Haveno's flawless operation (`torrc` options line, `torrc` option, ...) can **not** be overwritten*
* Expected Input Format: * Expected Input Format:
@ -295,7 +295,7 @@ Users are encouraged to experiment with options before use to determine which op
#### `--torControlHost` #### `--torControlHost`
+ Function + Function
The control `hostname` or `IP` of an already running `tor` service to be used by `Haveno` The control `hostname` or `IP` of an already running `tor` service to be used by Haveno
* Expected Input Format * Expected Input Format
@ -314,7 +314,7 @@ Users are encouraged to experiment with options before use to determine which op
#### `--torControlPort` #### `--torControlPort`
+ Function + Function
The control port of an already running `tor` service to be used by `Haveno` The control port of an already running `tor` service to be used by Haveno
* Expected Input Format * Expected Input Format
@ -448,7 +448,7 @@ Users are encouraged to experiment with options before use to determine which op
--- ---
## *Starting `Haveno` Using Externally Available `tor`* ## Starting Haveno Using Externally Available `tor`
### Dynamic Onion Assignment via `--torControlPort` ### Dynamic Onion Assignment via `--torControlPort`
```shell ```shell
$ /opt/haveno/bin/Haveno --torControlPort='9051' --torControlCookieFile='/var/run/tor/control.authcookie' --torControlUseSafeCookieAuth --useTorForXmr='on' --socks5ProxyXmrAddress='127.0.0.1:9050' $ /opt/haveno/bin/Haveno --torControlPort='9051' --torControlCookieFile='/var/run/tor/control.authcookie' --torControlUseSafeCookieAuth --useTorForXmr='on' --socks5ProxyXmrAddress='127.0.0.1:9050'