One Click Tangle

About ◈ Prerequisites ◈ Getting started ◈ Supporting the project ◈ Joining the discussion

---

About

This repository is where the IOTA Foundation hosts the open-source code for deploying Chrysalis IOTA Nodes and Networks "in one click". If you are looking how to deploy Shimmer Nodes you should check the Node Setup Repository. Those scripts are also compatible with Chrysalis.

The code is composed of:

• hornet: Script to deploy a new Hornet Node connected to the mainnet.
• hornet-k8s: Script to deploy a set of Hornet Nodes connected to the mainnet (Kubernetes).
• private-tangle: Script to deploy a new Private Tangle composed of Coordinator, Spammer and one regular Hornet Node.
• private-tangle/extra-nodes: Script to add extra Hornet Nodes to an existing Private Tangle.
• explorer: Script to deploy a new Tangle Explorer.
• bootstrap: Scripts that support Deployment on the AWS Marketplace for Hornet and the Private Tangle.

This is beta software, so there may be issues. Please report any issues in our issue tracker.

Related Community Projects: Hornet Playbook

Prerequisites

• jq JSON command line utility. Download

• GNU Sed.

Last but not least, to execute these scripts you need Docker and Docker Compose. Docker Compose is a tool for defining and running multi-container Docker applications. A series YAML files are used to configure the required services. This means all container services can be brought up in a single command. Docker Compose is installed by default as part of Docker for Windows and Docker for Mac, however Linux users will need to follow the instructions found here

You can check your current Docker and Docker Compose versions using the following commands:

docker-compose -v
docker version

Please ensure that you are using Docker version 18.03 or higher and Docker Compose 1.21 or higher and upgrade if necessary.

Getting started

Getting started - Hornet

First you need to clone the Repository

git clone https://github.com/iotaledger/one-click-tangle

Afterwards you can install a Hornet Node by

cd hornet-mainnet
chmod +x hornet.sh
./hornet.sh install

Getting started - Private Tangle

First you need to clone the Repository

git clone https://github.com/iotaledger/one-click-tangle

cd hornet-private-net
chmod +x private-tangle.sh
./private-tangle.sh install

You may also want to deploy a Tangle Explorer.

Additional instructions can be found on this tutorial.

Supporting the project

If this project has been useful to you and you feel like contributing, consider submitting a bug report, feature request or a pull request.

See our contributing guidelines for more information.

Joining the discussion

If you want to get involved in the community, need help with getting set up, have any issues or just want to discuss IOTA, Distributed Registry Technology (DRT), and IoT with other people, feel free to join our Discord.