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

[doc] Add instructions for Tor-enabled darkirc

The page is not added to src/SUMMARY.md as we are still in the process
of making this feature stable. When it comes time to officially support
and release darkirc, this page should be added to SUMMARY.
y 2 лет назад
Родитель
Сommit
2a028a8415
1 измененных файлов с 73 добавлено и 0 удалено
  1. 73 0
      doc/src/misc/tor-darkirc.md

+ 73 - 0
doc/src/misc/tor-darkirc.md

@@ -0,0 +1,73 @@
+# 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 {
+```
+
+Then modify:
+
+```rust
+outbound_connect_timeout: 60,
+channel_handshake_timeout: 55,
+channel_heartbeat_interval: 90,
+hosts_quarantine_limit: 10,
+outbound_peer_discovery_cooloff_time: 60,
+```
+
+## Build and run darkirc
+
+In the main repository: `make BINS="darkirc"`.
+
+The binary will create a configuration file at `~/.config/darkirc/darkirc_config.toml`.
+
+## Modify the DarkIRC configuration file
+
+```toml
+...
+allowed_transports = ["tor", "tor+tls"]
+...
+external_addr = ["tor://youraddress.onion:your-port"]
+...
+inbound = ["tcp://127.0.0.1:your-port"]
+...
+```
+
+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.
+
+## Run darkirc and connect to the network
+
+Run `./darkirc`. Welcome to the dark forest.
+
+## Troubleshooting
+
+Run `darkirc -vv` for verbose debugging. This will show detailed errors including
+tor connection issues.
+
+### DagSync spam
+
+If you see a many rapid `EventReq` messages in the log, it is possible that there is
+an incompatibility with your local `darkirc` database and the state of the network.
+
+This can be resolved by deleting `~/.local/darkfi/darkirc_db/`
+
+This is a known bug and we are working on a fix.