瀏覽代碼

doc/src: Update summary to reflect removal of tor inbound doc and updates for tor darkirc doc

doc/src/clients: rm tor inbound doc

doc/src/misc: rename tor dark irc and update content to include former tor inbound doc
darkfi 1 年之前
父節點
當前提交
b6797fa55b
共有 3 個文件被更改,包括 40 次插入67 次删除
  1. 1 3
      doc/src/SUMMARY.md
  2. 0 61
      doc/src/clients/tor_inbound.md
  3. 39 3
      doc/src/misc/tor_darkirc.md

+ 1 - 3
doc/src/SUMMARY.md

@@ -19,9 +19,7 @@
 - [DarkIRC](misc/darkirc/darkirc.md)
 	- [Private Message](misc/darkirc/private_message.md)
     - [Anonymous Nodes](clients/anonymous_nodes.md)
-        - [Tor Inbound Node](clients/tor_inbound.md)
-        - [tor-darkirc](misc/tor-darkirc.md)
-        
+        - [Tor DarkIRC](misc/tor_darkirc.md)
 
 # Developer Doc
 

+ 0 - 61
doc/src/clients/tor_inbound.md

@@ -1,61 +0,0 @@
-Hosting anonymous nodes
-=======================
-
-_To connect to Tor, we use [Arti](https://gitlab.torproject.org/tpo/core/arti). 
-This is an experimental project with incomplete security features. See Arti's 
-[roadmap](https://gitlab.torproject.org/tpo/core/arti#roadmap) for more 
-information._
-
-Using Tor, we can host anonymous nodes as Tor hidden services. To do
-this, we need to set up our Tor daemon and create a hidden service.
-The following instructions should work on any Linux system.
-
-## 1. **Install Tor**
-
-Tor can usually be installed with your package manager. For example
-on an `apt` based system we can run:
-
-```
-# apt install tor
-```
-
-This will install it. Now in `/etc/tor/torrc` we can set up the hidden
-service. For hosting an anonymous `darkirc` node, set up the following
-lines in the file:
-
-```
-HiddenServiceDir /var/lib/tor/darkfi_darkirc
-HiddenServicePort 25551 127.0.0.1:25551
-```
-
-Then restart Tor:
-
-```
-# /etc/init.d/tor restart
-```
-
-You can grab the hostname of your hidden service from the directory:
-
-```
-# cat /var/lib/tor/darkfi_darkirc/hostname
-```
-
-For example purposes, let's assume it's
-`jamie3vkiwibfiwucd6vxijskbhpjdyajmzeor4mc4i7yopvpo4p7cyd.onion`.
-
-## 2. **Setup `darkirc`**
-
-After compiling `darkirc`, run it once to spawn the config file. Then
-edit it to contain the following:
-
-```toml
-inbound = ["tcp://127.0.0.1:25551"]
-external_addrs = ["tor://jamie3vkiwibfiwucd6vxijskbhpjdyajmzeor4mc4i7yopvpo4p7cyd.onion:25551"]
-```
-
-Now when you start `darkirc`, the hidden service will be announced as
-a peer and people will be able to connect to it when they discover
-you as a peer.
-
-These instructions are also applicable to other nodes in the DarkFi
-ecosystem, e.g. `darkfid`.

+ 39 - 3
doc/src/misc/tor-darkirc.md → doc/src/misc/tor_darkirc.md

@@ -1,7 +1,43 @@
 # Set-up a Tor-enabled darkirc node
 
+_To connect to Tor, we use [Arti](https://gitlab.torproject.org/tpo/core/arti). 
+This is an experimental project with incomplete security features. See Arti's 
+[roadmap](https://gitlab.torproject.org/tpo/core/arti#roadmap) for more 
+information._
+
+Using Tor, we can host anonymous nodes as Tor hidden services. To do
+this, we need to set up our Tor daemon and create a hidden service.
+The following instructions should work on any Linux system.
+
 ## Step 1: Install Tor and Launch a Hidden Service
-[Install Tor](https://darkrenaissance.github.io/darkfi/clients/tor_inbound.html).
+
+Tor can usually be installed with your package manager. For example
+on an `apt` based system we can run:
+
+```
+# apt install tor
+```
+
+This will install it. Now in `/etc/tor/torrc` we can set up the hidden
+service. For hosting an anonymous `darkirc` node, set up the following
+lines in the file:
+
+```
+HiddenServiceDir /var/lib/tor/darkfi_darkirc
+HiddenServicePort 25551 127.0.0.1:25551
+```
+
+Then restart Tor:
+
+```
+# /etc/init.d/tor restart
+```
+
+You can grab the hostname of your hidden service from the directory:
+
+```
+# cat /var/lib/tor/darkfi_darkirc/hostname
+```
 
 Note your `.onion` address and the ports you used while setting up the
 Hidden Service.
@@ -53,12 +89,12 @@ Run `./darkirc`. Welcome to the dark forest.
 
 Run `darkirc -vv` for verbose debugging. This will show detailed errors including
 tor connection issues. Refer to 
-[Network troubleshooting](https://darkrenaissance.github.io/darkfi/misc/network-troubleshooting.html)
+[Network troubleshooting](../misc/network-troubleshooting.html)
 for further troubleshooting resources.
 
 ### Connection issues
 
-Review the configuration file for any mistakes. Check for duplicated variables.
+Review the configuration file for any mistakes. Check for duplicate variables.
 
 ### DagSync spam