iotaledger / one-click-tangle

"One Click Tangle" intends to make lives easier to IOTA adopters by providing pre-configured scripts and recipes that allow to deploy IOTA Networks and Nodes "in one click".
MIT License
55 stars 36 forks source link

feature/Add_notes_on_autopeering_and_settings #47

Closed peterokwara closed 2 years ago

peterokwara commented 2 years ago

Description of change

Autopeering is a feature of hornet that allows a node to automatically find peers through the autopeering module.

This PR attempts to clarify the procedure on how to enable and use autopeering in the documentation. Ports like 14626 are explicitly used for autopeering and this is added as part of the docker-compose configuration file.

Type of change

Choose a type of change, and delete any options that are not relevant.

How the change has been tested

  1. Clone the one-click-tangle repository
  2. Obtain the latest configuration file from gohornet repo https://github.com/gohornet/hornet/blob/v1.0.4/config.json and replace the existing configuration with it.
  3. Change the dashboard.bindAddress to 0.0.0.0:14265
  4. Change the dashboard.passwordHash and dashboard.passwordSalt to the respective value found in the config file in one-click-tangle/hornet-mainnet folder https://github.com/iotaledger/one-click-tangle/blob/chrysalis/hornet-mainnet/config/config.json
  5. Enable autopeering by adding "Autopeering" to "node.enablePlugins"
  6. Check to see if there are entry nodes listed in the p2p.autopeering.entryNode section of the config file. The gohornet/hornet config file has some entry nodes in it https://github.com/gohornet/hornet/blob/v1.0.4/config.json
  7. Run the private tangle by running ./hornet.sh install -i "gohornet\/hornet:1.0.4"
  8. Check logs to see if autopeering of peers is happening.
  9. Check dashboard to see if the node has connected to any peers.

Change checklist

jmcanterafonseca-iota commented 2 years ago

I think for AWS we also need a note on autopeering, similar to the one we have in the regular README