Conceal Wiki

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
smart-nodes [2019/07/24 16:04]
taegus
smart-nodes [2020/02/23 12:18] (current)
boot2thrill
Line 3: Line 3:
 ====About==== ====About====
  
-**ConcealNodeGuard** is a guardian process that monitors over the conceal ​daemon. It can catch daemon errors and also monitors if the block count is increasing. In case an error is detected or the block count is stale it restarts the daemon and notifies the devs on the Discord over a web hook, or sends a mail to the recipient, or both.+**Conceal Node Guard** is a guardian process that monitors over the Conceal ​daemon. It can catch daemon errors and also monitors if the block count is increasing. In case an error is detected or the block count is stale, the **Conceal Node Guard** ​restarts the daemon and notifies the devs in Discord over a web hook, or sends an email to the recipient, or both.
  
-It can also connect to a pool so the node is then listed among available nodes either ​for infrastructure monitoring or for remote node with fee listing.+The **Conceal Node Gaurd** ​can also connect to a poolso the node is then listed among available nodes for either  ​infrastructure monitoring or remote node with listing ​fee.
  
 ====Installation==== ====Installation====
  
-To install and run it you have two options. Install and run it via the node.js virtual machine or you can download the pre-compiled executable that already includes node.js and run that. In that case you have 0 dependencies.+To install and run the **Conceal Node Guard** ​you have two options
  
-If you go with the first options the continue reading, ​otherwise ​go to [[https://​github.com/​ConcealNetwork/​conceal-guardian/​blob/​master/​INSTALL.md|installation page]].+  - **Option 1** is to install and run it via the node.js virtual machine. ​If you go with the **Option 1**, then continue reading
 +  - **Option 2** is to download and run the pre-compiled executable that already includes node.js. For **Option 2**, go to this [[https://​github.com/​ConcealNetwork/​conceal-guardian/​blob/​master/​INSTALL.md|installation page]]. **Option 2** will not have any dependencies.
  
-First need to install ​dependencies. There are two: +For **Option 1**, you will need to install two dependencies
-  * [[https://​nodejs.org/​en/​|nodejs]]+  * [[https://​nodejs.org/​en/​|Node.js]]
   * [[https://​www.npmjs.com/​|npm]]   * [[https://​www.npmjs.com/​|npm]]
  
-You can see how to install ​it [[https://​nodejs.org/​en/​download/​package-manager/​|here]].+You can install ​**Node.js via package manager** ​[[https://​nodejs.org/​en/​download/​package-manager/​|here]].
  
-When you have it installed you can run the guardian by simply doing:+Once you have installed ​**Node.js** and **npm** ​you can run the guardian by simply doing:
  
   - npm install   - npm install
   - node index.js   - node index.js
  
-Before ​doing that however its wise to check the config.json and set the correct settings. For interactive config setup please refer to [[https://​github.com/​ConcealNetwork/​conceal-guardian/​blob/​master/​INSTALL.md|installation page]]. ​+Before ​you run the guardian, ​check the config.json and set the correct settings. For an interactive config setupplease refer to this [[https://​github.com/​ConcealNetwork/​conceal-guardian/​blob/​master/​INSTALL.md|installation page]]. ​
  
-You can see a sample of config.json file and detailed instructions [[https://​github.com/​ConcealNetwork/​conceal-guardian|here]].+You can see an example ​config.json file and detailed instructions [[https://​github.com/​ConcealNetwork/​conceal-guardian|here]].
  
 ====API==== ====API====
  
-The Guardian ​can have an api that listens for incoming requests and returns some info about the node. The api only has one handler (all other request are considered invalid and return 403):+The **Conceal Node Guard** ​can have an api that listens for incoming requests and returns some info about the node. The api only has one handler (all other request are considered invalid and return 403):
  
   * getInfo   * getInfo
Line 36: Line 37:
 Click [[https://​github.com/​ConcealNetwork/​conceal-guardian|here]] to see a result example. Click [[https://​github.com/​ConcealNetwork/​conceal-guardian|here]] to see a result example.
  
 +====HTML====
 +The **Conceal Node Guard** has a web interface. A feature available is to have the daemon automatically update to the newest version. By default, the auto update of the daemon must be manually enabled in the config.json file or with the interactive setup. NOTE: The auto update feature only applies to the daemon and not the guardian. ​   ​
 +
 +Click this [[http://​5.189.177.60:​8080/​index.html|Example node]] to view a live node on the HTML interface. Below is an example of the HTML interface. To view your node via HTML, just copy the following URL to your browser and replace "​YOUR.IP.ADDRESS"​ with your actual IP address: **YOUR.IP.ADDRESS:​8080/​index.html** ​
 +
 +{{ :​remote_node.png?​|}}
 +
 +A stand alone node pool is available for all remote nodes. Each node registers to the pool and sends periodic updates to allow  visibility on the explorer. For a full list of nodes click [[https://​explorer.conceal.network/​index.html#​nodes|here]]. ​
 +
 +{{ :​node_list.png?​|}}