Skip to content
This repository was archived by the owner on Dec 10, 2022. It is now read-only.

Commit c7732de

Browse files
committed
docs(README): add more examples how to use config
1 parent 9a6a97f commit c7732de

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A server application to run tox bootstrap node.
44

55
## Building and running
66

7-
You'll need [Rust] >= 1.26.0 and [libsodium].
7+
You'll need [Rust] >= 1.31.0.
88

99
Build with:
1010

@@ -78,7 +78,7 @@ In order to run with config, run with `--config <file>`.
7878
Example config.yml is below.
7979
```yaml
8080
log-type: Stderr
81-
keys-file: keys
81+
keys-file: ./keys
8282
udp-address: 0.0.0.0:33445
8383
tcp-addresses:
8484
- 0.0.0.0:33445
@@ -88,12 +88,13 @@ bootstrap-nodes:
8888
addr: 198.98.51.198:33445
8989
- pk: DA4E4ED4B697F2E9B000EEFE3A34B554ACD3F45F5C96EAEA2516DD7FF9AF7B43
9090
addr: 185.25.116.107:33445
91-
no-lan: True
91+
threads: auto # or any u16 > 0
92+
lan-discovery: True
9293
```
9394
Or you can use it with CLI like this
9495
```sh
9596
tox-node --keys-file keys \
96-
--bootstrap-node 1D5A5F2F5D6233058BF0259B09622FB40B482E4FA0931EB8FD3AB8E7BF7DAF6F 198.98.51.198:33445 \
97+
--bootstrap-node 1D5A5F2F5D6233058BF0259B09622FB40B482E4FA0931EB8FD3AB8E7BF7DAF6F 198.98.51.198:33445 \
9798
--udp-address '0.0.0.0:33445' --tcp-address '0.0.0.0:33445' \
9899
--motd "{{start_date}} {{uptime}} Tcp: incoming {{tcp_packets_in}}, outgoing {{tcp_packets_out}}, Udp: incoming {{udp_packets_in}}, outgoing {{udp_packets_out}}"
99100
```

0 commit comments

Comments
 (0)