From c2ba13420c2ba1756a5784cc357bdca7153d4f89 Mon Sep 17 00:00:00 2001 From: Dr-Electron Date: Mon, 22 Jan 2024 15:40:53 +0100 Subject: [PATCH] Update docs with placeholders until release --- .../iota-sandbox/docs/getting-started.md | 56 ++++++++++++++++--- 1 file changed, 49 insertions(+), 7 deletions(-) diff --git a/docs/build/iota-sandbox/docs/getting-started.md b/docs/build/iota-sandbox/docs/getting-started.md index 901e9703944..a27d65a63ec 100644 --- a/docs/build/iota-sandbox/docs/getting-started.md +++ b/docs/build/iota-sandbox/docs/getting-started.md @@ -1,3 +1,6 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + # Getting Started With the IOTA Sandbox You can use this guide to [install](#install-the-iota-sandbox-using-docker) @@ -9,10 +12,10 @@ It includes everything you need to develop your own IOTA dApps, plugins, and mor ### Requirements 1. A recent release of [Docker](https://www.docker.com/). 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](https://docs.docker.com/). +2. [Docker Compose CLI plugin](https://docs.docker.com/compose/install/linux/). +3. Make sure ports 80, 80... are not in use by other applications. If they are change them in the `.env` file. -2. [Git](https://git-scm.com/). - -### Clone the Repository +### Download the latest release :::note @@ -20,13 +23,32 @@ The commands assume you are using Linux. ::: -Once you have completed all the installation requirements, -you can clone the repo and navigate to the `sandbox` folder by running the following command: +Once you have completed all the installation [requirements](#requirements), you can download one of the latest releases, depending on the network you want to base the sandbox on, by running the following command: + + + + +```sh +mkdir iota-sandbox && cd iota-sandbox && curl -L https://github.com/Dr-Electron/iota-sandbox/releases/download/iota-v1.0.0-rc.1/iota-v1.0.0-rc.1_sandbox.tar.gz | tar -zx +``` + + + + +```sh +mkdir iota-sandbox && cd iota-sandbox && curl -L https://github.com/Dr-Electron/iota-sandbox/releases/download/shimmer-v1.0.0-rc.1/shimmer-v1.0.0-rc.1_sandbox.tar.gz | tar -zx +``` + + + ```sh -git clone https://github.com/iotaledger/iota-sandbox && cd iota-sandbox/sandbox +mkdir iota-sandbox && cd iota-sandbox && curl -L https://github.com/Dr-Electron/iota-sandbox/releases/download/testnet-v1.0.0-rc.1/testnet-v1.0.0-rc.1_sandbox.tar.gz | tar -zx ``` + + + ### Prepare :::note @@ -38,10 +60,30 @@ The commands assume you are using Linux. #### Set Up Your Environment In most cases the default setup should be enough. But you can edit the `.env` file to configure some optional settings: + + + +```sh reference +https://github.com/iotaledger/iota-sandbox/blob/main/iota/.env +``` + + + + ```sh reference -https://github.com/iotaledger/iota-sandbox/blob/add-chronicle-setup/sandbox/.env +https://github.com/iotaledger/iota-sandbox/blob/shimmer/iota/.env ``` + + + +```sh reference +https://github.com/iotaledger/iota-sandbox/blob/main/testnet/.env +``` + + + + #### Bootstrap If you haven't run the IOTA Sandbox before, you need to bootstrap it. To do that, just run the following command: