From 59a5f7b4fcf4a5d808335e09025e4a639e0bfc64 Mon Sep 17 00:00:00 2001
From: silverpill <silverpill@firemail.cc>
Date: Thu, 23 Feb 2023 19:49:04 +0000
Subject: [PATCH] Add Tor instance installation doc

---
 docs/onion.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 docs/onion.md

diff --git a/docs/onion.md b/docs/onion.md
new file mode 100644
index 0000000..6e44ae3
--- /dev/null
+++ b/docs/onion.md
@@ -0,0 +1,27 @@
+# Tor instance
+
+Install Tor.
+
+Install Mitra. Uncomment or add the following block to Mitra configuration file:
+
+```yaml
+federation:
+  proxy_url: 'socks5h://127.0.0.1:9050'
+```
+
+Where `127.0.0.1:9050` is the address and the port where Tor proxy is listening.
+
+Configure the onion service by adding these lines to `torrc` configuration file:
+
+```
+HiddenServiceDir /var/lib/tor/mitra/
+HiddenServicePort 80 127.0.0.1:8383
+```
+
+Where `8383` should correspond to `http_port` setting in Mitra configuration file.
+
+Restart the Tor service. Inside the `HiddenServiceDir` directory find the `hostname` file. This file contains the hostname of your onion service. Change the value of `instance_uri` parameter in Mitra configuration file to that hostname (it should end with `.onion`).
+
+Start Mitra.
+
+For more information about running onion services, visit https://community.torproject.org/onion-services/setup/