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

Commit 6fbc3cf

Browse files
committed
README.md: we are in nixpkgs
1 parent af96d73 commit 6fbc3cf

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,29 @@ RUST_LOG=tox=trace cargo run --release
2828

2929
Also it's possible to use syslog via `--log-type` parameter.
3030

31+
### Running tox-node on NixOS
32+
33+
If you are using NixOS (unstable channel), you can install and run tox-node by adding `services.tox-node.enable = true;` to your `configuration.nix`.
34+
35+
Configuration options are also available. An example of configuration:
36+
37+
```nix
38+
{
39+
services.tox-node = {
40+
enable = true;
41+
42+
logType = "Syslog";
43+
keysFile = "/var/lib/tox-node/keys";
44+
udpAddress = "0.0.0.0:33445";
45+
tcpAddresses = [ "0.0.0.0:33445" ];
46+
tcpConnectionLimit = 8192;
47+
lanDiscovery = true;
48+
threads = 1;
49+
motd = "Hi from tox-rs! I'm up {{uptime}}. TCP: incoming {{tcp_packets_in}}, outgoing {{tcp_packets_out}}, UDP: incoming {{udp_packets_in}}, outgoing {{udp_packets_out}}";
50+
};
51+
}
52+
```
53+
3154
## MOTD
3255

3356
MOTD is an abbreviation for The Message of The Day. Tox bootstrap nodes have a

0 commit comments

Comments
 (0)