Skip to content

Commit

Permalink
Add env description and missing endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
Dr-Electron committed Nov 28, 2023
1 parent 66ed39e commit c7a5475
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 20 deletions.
23 changes: 4 additions & 19 deletions docs/build/iota-sandbox/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
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)
Expand Down Expand Up @@ -40,7 +37,10 @@ The commands assume you are using Linux.

#### Set Up Your Environment

TODO - I didn't need any extra setup steps to run the sandbox, am I missing something? Or can wedelete this?
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/add-chronicle-setup/sandbox/.env
```

#### Bootstrap

Expand All @@ -56,26 +56,11 @@ sudo ./bootstrap.sh

You can start the IOTA Sandbox by running:

<Tabs groupId="profile" queryString>
<TabItem value="default" label="Default">

```sh
docker compose up -d
```

</TabItem>
<TabItem value="wasp" label="Wasp">

```sh
docker compose --profile=wasp up -d
```

</TabItem>
</Tabs>

- `-d` Instructs Docker to start the containers in the background.
- `-d` Instructs Docker to start the containers in the background.


:::tip Available endpoints

Expand Down
4 changes: 3 additions & 1 deletion docs/build/iota-sandbox/docs/references/endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,6 @@ API: `http://localhost/faucet/`
Dashboard: `http://localhost/wasp/`
API: `http://localhost/wasp/api/`

## TODO: Add missing endpoints
## Chronicle

API: `http://localhost/chronicle/`

0 comments on commit c7a5475

Please sign in to comment.