Skip to content

Commit

Permalink
docs: updating dockerhub links on localnet docs (#445)
Browse files Browse the repository at this point in the history
* docs: updating dockerhub links on localnet docs
---------

Co-authored-by: Neil Campbell <neil.campbell@makerx.com.au>
  • Loading branch information
aorumbayev and neilcampbell authored Mar 2, 2024
1 parent aa3840a commit 9d4df31
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/features/localnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The AlgoKit LocalNet is built with 30,000 participation keys generated and after

## Supported operating environments

We publish DockerHub images for `arm64` and `amd64`, which means that AlgoKit LocalNet is supported on Windows, Linux and Mac on Intel and AMD chipsets (including Mac M1).
We rely on the official Algorand docker images for Indexer, Conduit and Algod, which means that AlgoKit LocalNet is supported on Windows, Linux and Mac on Intel and AMD chipsets (including Apple Silicon).

## Functionality

Expand All @@ -37,8 +37,9 @@ To create / start your AlgoKit LocalNet instance you can run `algokit localnet s

If it's the first time running it on your machine then it will download the following images from DockerHub:

- [`makerxau/algorand-sandbox-dev`](https://hub.docker.com/r/makerxau/algorand-sandbox-dev) (~150-200 MB)
- [`makerxau/algorand-indexer-dev`](https://hub.docker.com/r/makerxau/algorand-indexer-dev) (~25 MB)
- [`algorand/algod`](https://hub.docker.com/r/algorand/algod) (~500 MB)
- [`algorand/indexer`](https://hub.docker.com/r/algorand/indexer) (~96 MB)
- [`algorand/conduit`](https://hub.docker.com/r/algorand/conduit) (~98 MB)
- [`postgres:13-alpine`](https://hub.docker.com/_/postgres) (~80 MB)

Once they have downloaded, it won't try and re-download images unless you perform a `algokit localnet reset`.
Expand Down Expand Up @@ -76,7 +77,6 @@ Assuming you have previously used a default LocalNet, the path `./algokit/sandbo

It is important to note that only the configuration files for a named LocalNet instance should be changed. Any changes made to the default LocalNet instance will be reverted by AlgoKit.


### Stopping and Resetting the LocalNet

To stop the LocalNet you can execute `algokit localnet stop`. This will turn off the containers, but keep them ready to be started again in the same state by executing `algokit localnet start`.
Expand Down

0 comments on commit 9d4df31

Please sign in to comment.