Quick start

Your first node

• Sign in to your Staex account or create a new one at https://cas.staex.io/.
• On the New network page of self-service portal create a new network certificate.
• Install MCC by following instructions on Staex repository page.
• On the New node page of self-service portal generate node private key and certificate. You will need the network key that you've generated on the previous step. Alternatively use mcc generate-node-certificate command to do the same.
• Now you're ready to go! Start mcc service and enjoy your self-hosted, multi-hop network.

# start and enable on boot
systemctl enable --now mcc
# get status
systemctl status mcc
# restart
systemctl restart mcc
# view logs
journalctl -u mcc -e

# start and enable on boot
service mcc enable
service mcc start
# get status
service mcc status
# restart
service mcc restart
# view the last 50 lines of logs
logread -e mcc -l 50

# start
sudo launchctl start io.staex.mcc
# get status
sudo launchctl list io.staex.mcc
# restart (restarts automatically after stopping)
sudo launchctl stop io.staex.mcc
# fully stop
sudo launchctl unload /Library/LaunchDaemons/io.staex.mcc.plist
sudo launchctl stop io.staex.mcc
# view logs
sudo less +G /Library/Logs/mcc.log
# enable on boot
# add <key>RunAtLoad</key><true/> to /Library/LaunchDaemons/io.staex.mcc.plist

On OpenWRT you need to run these additional commands to configure Dnsmasq to resolved node IDs.

uci set dhcp.@dnsmasq[-1].domainneeded=0
uci set dhcp.@dnsmasq[-1].confdir=/etc/dnsmasq.d
uci commit dhcp
service dnsmasq restart

Other nodes

To add more nodes to the network repeat the last three steps for each new node and then configure a parent node for each node.

# file /etc/mcc/mcc.conf
parents = x.x.x.x:9376

Here x.x.x.x is the address of the first node you have created. Usually a parent node has public IP address but this is not required. You can chain-link nodes to create multi-hop network. Staex ensures global connectivity even if a child node can only "see" its parent but not the other nodes.

Don't forget to open port 9376 for UDP traffic on each node.

If everything went well your new nodes should be visible in the output of the following command on the parent node.

mcc nodes

They will also be visible on Networks page in self-service portal.