Просмотр исходного кода

[doc] Fix tor-darkirc guide

Remove bad instructions that told people to modify Rust source code.
y 2 лет назад
Родитель
Сommit
3e2893dd0e
1 измененных файлов с 20 добавлено и 33 удалено
  1. 20 33
      doc/src/misc/tor-darkirc.md

+ 20 - 33
doc/src/misc/tor-darkirc.md

@@ -1,60 +1,47 @@
 # Set-up a Tor-enabled darkirc node
 
-NOTE: Unstable/not private
-
 ## Step 1: Install Tor and Launch a Hidden Service
 [Install Tor](https://darkrenaissance.github.io/darkfi/clients/tor_inbound.html).
 
 Note your `.onion` address and the ports you used while setting up the
 Hidden Service.
 
-## Step 2: Configure Network Settings
-
-Tor requires specific timeout settings in order to maintain a stable
-connection.
-
-To configure these settings, modify `src/net/settings.rs`. For now, this must be done 
-manually before building the binary.
-
-Locate the section beginning with the line: 
-```rust
-impl Default for Settings {
-```
+## Step 2: Build and run darkirc
 
-Then modify:
+In the main repository: `make BINS="darkirc"`.
 
-```rust
-outbound_connect_timeout: 60,
-channel_handshake_timeout: 55,
-channel_heartbeat_interval: 90,
-hosts_quarantine_limit: 10,
-outbound_peer_discovery_cooloff_time: 60,
-```
+The binary will create a configuration file at `~/.config/darkirc/darkirc_config.toml`.
 
-## Build and run darkirc
+## Step 3: Configure Network Settings
 
-In the main repository: `make BINS="darkirc"`.
+Tor requires specific timeout settings in order to maintain a stable
+connection.
 
-The binary will create a configuration file at `~/.config/darkirc/darkirc_config.toml`.
+Ensure the config file contains the following:
 
-## Modify the DarkIRC configuration file
+_If you notice some settings are not present in the file, simply add them._
 
 ```toml
-...
+outbound_connect_timeout = 60
+channel_handshake_timeout = 55
+channel_heartbeat_interval = 90
+hosts_quarantine_limit = 10
+outbound_peer_discovery_cooloff_time = 60
+
 allowed_transports = ["tor", "tor+tls"]
-...
 external_addr = ["tor://youraddress.onion:your-port"]
-...
+
+# inbound settings
 inbound = ["tcp://127.0.0.1:your-port"]
-...
+inbound_connections = 8
 ```
 
 This configuration allows your node to send and receive traffic only via Tor.
 
-The settings `external_addr` and `inbound` are optional, but enabling them
-will increase the strength and reliability of the network.
+The settings under `inbound settings`, but enabling them will increase the strength and 
+reliability of the network.
 
-## Run darkirc and connect to the network
+## Step 4: Connect
 
 Run `./darkirc`. Welcome to the dark forest.