Skip to main content

Getting Started With the IOTA Sandbox

You can use this guide to install and run the IOTA Sandbox. It includes everything you need to develop your own IOTA dApps, plugins, and more.

Install the IOTA Sandbox Using Docker​

Requirements​

  1. A recent release of Docker. Avoid using the Docker version shipped with your OS since these are mostly out of date. You can find installation instructions in the official Docker documentation.
  2. Docker Compose CLI plugin.
  3. sed
  4. jq
  5. Make sure ports 80 and 8082 are not in use by other applications. If they are change them in the .env file. Optional: If you enabled the explorer profile by default it will use port 8081

Download the Latest Release​

note

The commands assume you are using Linux.

Once you have completed all the installation requirements, you can download the sandbox. The following command will download the latest version.

mkdir iota-sandbox && cd iota-sandbox && curl -L https://github.com/iotaledger/iota-sandbox/releases/latest/download/iota_sandbox.tar.gz | tar -zx

Prepare​

Linux Commands

The commands assume you are using Linux.

Set Up Your Environment​

In most cases, the default setup should be enough. So, you can do cp .env.example .env to use the default setup. You can also edit the .env file to configure some optional settings:

sandbox/.env.example
loading...

Bootstrap​

If you haven't run the IOTA Sandbox before, you need to bootstrap it. To do that, just run the following command:

sudo ./bootstrap.sh

Run​

Start the IOTA Sandbox​

You can start the IOTA Sandbox by running:

docker compose up -d
  • -d Instructs Docker to start the containers in the background.
Available endpoints

Once the container is up and running, you can access the node using the available endpoints.

Stop the IOTA Sandbox​

You can stop the IOTA Sandbox by running the following commands:

docker compose down