# README
Relay Node For QNG Network
QNG Relay node is a kind of node which uses circuit transport protocol. It can route communication between two peers. So it can also be used to help private network QNG nodes to "Hole-punching".
Relay node connections are end-to-end encrypted, which means that the peer acting as the relay is unable to read or tamper with any traffic that flows through the connection.
Installation
~ cd ./cmd/relaynode
~ go build
~ ./relaynode -h
Getting Started
- Start
relaynode
~ ./relaynode
-
Copy
Relay Address
from relaynode log. -
Configure startup parameters for QNG nodes in the private network.
~ ./qitmeer --relaynode=[Relay Address]
RPC
~ ./relaynode --norpc=false
If you don't want to use the default configuration, you can:
~ ./relaynode -h
... ...
--rpclisten
--rpcuser
--rpcpass
... ...
- Example of calling RPC:(You must pay attention to whether the respective RPC port numbers are consistent)
~ ./cli.sh peerinfo
Usage
-
If you do not want to use the relay node default configuration parameters, you can use
./relaynode -h
to help for custom configuration. -
If your environment is having trouble getting public IP, please try using
./relaynode --externalip=[Your Public IP]
-
If you want to use DNS service:
./relaynode --externalip=[Your domain name]