From 0e8f60d50186a8f3baf84cfb7439598057486cd0 Mon Sep 17 00:00:00 2001 From: Itamar Perez Date: Tue, 18 Apr 2023 10:30:57 -0700 Subject: [PATCH] update mix-node setup docs with node description --- documentation/docs/src/nodes/mix-node-setup.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/documentation/docs/src/nodes/mix-node-setup.md b/documentation/docs/src/nodes/mix-node-setup.md index fad1326a7c..123edc726a 100644 --- a/documentation/docs/src/nodes/mix-node-setup.md +++ b/documentation/docs/src/nodes/mix-node-setup.md @@ -355,6 +355,20 @@ username soft nofile 4096 Then reboot your server and restart your mixnode. +## Node Description +Node description is a short text that describes your node. It is displayed in the `nym-mixnode list` command and in the `nym-mixnode node-details` command. it also shows up in the node explorer to let people know what your node is about and link to your website. + +To set your node description, create a file called `description.toml` and put it in the same directory as your `config.toml` file. The file should look like this: + +```toml +name = "Winston Smith" +description = "I am the Sphinx" +link = "https://nymtech.net" +location = "Giza, Egypt" +``` + +you will need to restart your node for the changes to take effect. + ## Node Families Node family involves setting up a group of mix nodes that work together to provide greater privacy and security for network communications. This is achieved by having the nodes in the family share information and routes, creating a decentralized network that makes it difficult for third parties to monitor or track communication traffic.