Differences

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

--- smart-nodes [2019/06/15 13:20] – created smiley7
+++ smart-nodes [2019/07/24 20:04] – taegus
@@ Line 1: / Line 1: @@
-======Conceal Node Guardian======
+==== Conceal Node Guardian ====
-=====1. 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.
 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.
+====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.
+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]].
+First need to install dependencies. There are two:
+  * [[https://nodejs.org/en/|nodejs]]
+  * [[https://www.npmjs.com/|npm]]
+You can see how to install it [[https://nodejs.org/en/download/package-manager/|here]].
+When you have it installed you can run the guardian by simply doing:
+  - npm install
+  - 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]].
+You can see a sample of config.json file and detailed instructions [[https://github.com/ConcealNetwork/conceal-guardian|here]].
+====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):
+  * getInfo
+Click [[https://github.com/ConcealNetwork/conceal-guardian|here]] to see a result example.