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

Commit fe0fa56

Browse files
committed
docs(README): add examples of how to use tox-node with args or config file
1 parent 977bfdf commit fe0fa56

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,31 @@ hexdump -n 32 -e '8 "%08x" 1 "\n"' /dev/random
7272
od -vN 32 -An -tx1 /dev/random | tr -d " \n" ; echo
7373
```
7474

75+
## Config or CLI
76+
77+
In order to run with config, run with `--config <file>`.
78+
Example config.yml is below.
79+
```yaml
80+
log-type: Stderr
81+
keys-file: keys
82+
udp-address: 0.0.0.0:33445
83+
tcp-addresses:
84+
- 0.0.0.0:33445
85+
motd: "{{start_date}} {{uptime}} Tcp: incoming {{tcp_packets_in}}, outgoing {{tcp_packets_out}}, Udp: incoming {{udp_packets_in}}, outgoing {{udp_packets_out}}"
86+
bootstrap-nodes:
87+
- pk: 1D5A5F2F5D6233058BF0259B09622FB40B482E4FA0931EB8FD3AB8E7BF7DAF6F
88+
addr: 198.98.51.198:33445
89+
- pk: DA4E4ED4B697F2E9B000EEFE3A34B554ACD3F45F5C96EAEA2516DD7FF9AF7B43
90+
addr: 185.25.116.107:33445
91+
no-lan: True
92+
```
93+
Or you can use it with CLI like this
94+
```sh
95+
tox-node --keys-file keys \
96+
--bootstrap-node 1D5A5F2F5D6233058BF0259B09622FB40B482E4FA0931EB8FD3AB8E7BF7DAF6F 198.98.51.198:33445 \
97+
--udp-address '0.0.0.0:33445' --tcp-address '0.0.0.0:33445' \
98+
--motd "{{start_date}} {{uptime}} Tcp: incoming {{tcp_packets_in}}, outgoing {{tcp_packets_out}}, Udp: incoming {{udp_packets_in}}, outgoing {{udp_packets_out}}"
99+
```
100+
75101
[libsodium]: https://github.com/jedisct1/libsodium
76102
[Rust]: https://www.rust-lang.org

0 commit comments

Comments
 (0)