Skip to content

Commit 77311af

Browse files
scottcartercoAlex Johnson
andauthored
docs: Updated docker doc to reference latest CLI version (ignite#2987)
Updated the documentation to reflect the latest CLI version (v.0.25.1) and updated the command examples to use the simplified 'scaffold chain planet' command. Documentation also references and notes version 0.24.1 which is the most recent specifically tagged version to-date. Co-authored-by: Alex Johnson <alex@shmeeload.xyz>
1 parent a064cd8 commit 77311af

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docs/docs/kb/09-docker.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ After you scaffold and start a chain in your Docker container, all Ignite CLI co
2323

2424
```bash
2525
docker run -ti ignitehq/cli -h
26-
docker run -ti ignitehq/cli scaffold chain github.com/test/planet
26+
docker run -ti ignitehq/cli scaffold chain planet
2727
docker run -ti ignitehq/cli chain serve
2828
```
2929

@@ -33,9 +33,7 @@ When Docker is installed, you can build a blockchain with a single command.
3333

3434
Ignite CLI, and the chains you serve with Ignite CLI, persist some files.
3535
When using the CLI binary directly, those files are located in `$HOME/.ignite`
36-
and `$HOME/.cache`, but in the context of Docker it's better to use a directory different than `$HOME`, so we use `$HOME/sdh`. This folder should be created
37-
manually prior to the docker commands below, or else Docker creates it with the
38-
root user.
36+
and `$HOME/.cache`, but in the context of Docker it's better to use a directory different than `$HOME`, so we use `$HOME/sdh`. This folder should be created manually prior to the docker commands below, or else Docker creates it with the root user.
3937

4038
```bash
4139
mkdir $HOME/sdh
@@ -44,12 +42,12 @@ mkdir $HOME/sdh
4442
To scaffold a blockchain `planet` in the `/apps` directory in the container, run this command in a terminal window:
4543

4644
```bash
47-
docker run -ti -v $HOME/sdh:/home/tendermint -v $PWD:/apps ignitehq/cli:0.16.0 scaffold chain github.com/hello/planet
45+
docker run -ti -v $HOME/sdh:/home/tendermint -v $PWD:/apps ignitehq/cli:0.24.1 scaffold chain planet
4846
```
4947

5048
Be patient, this command takes a minute or two to run because it does everything for you:
5149

52-
- Creates a container that runs from the `ignitehq/cli:0.16.0` image.
50+
- Creates a container that runs from the `ignitehq/cli:0.24.1` image.
5351
- Executes the Ignite CLI binary inside the image.
5452
- `-v $HOME/sdh:/home/tendermint` maps the `$HOME/sdh` directory in your local computer (the host machine) to the home directory `/home/tendermint` inside the container.
5553
- `-v $PWD:/apps` maps the current directory in the terminal window on the host machine to the `/apps` directory in the container. You can optionally specify an absolute path instead of `$PWD`.
@@ -63,7 +61,7 @@ Be patient, this command takes a minute or two to run because it does everything
6361
To start the blockchain node in the Docker container you just created, run this command:
6462

6563
```bash
66-
docker run -ti -v $HOME/sdh:/home/tendermint -v $PWD:/apps -p 1317:1317 -p 26657:26657 ignitehq/cli:0.16.0 chain serve -p planet
64+
docker run -ti -v $HOME/sdh:/home/tendermint -v $PWD:/apps -p 1317:1317 -p 26657:26657 ignitehq/cli:0.24.1 chain serve -p planet
6765
```
6866

6967
This command does the following:
@@ -85,16 +83,17 @@ You can specify which version of Ignite CLI to install and run in your Docker co
8583
- By default, `ignitehq/cli` resolves to `ignitehq/cli:latest`.
8684
- The `latest` image tag is always the latest stable [Ignite CLI release](https://github.com/ignite/cli/releases).
8785

88-
For example, if latest release is [v0.15.1](https://github.com/ignite/cli/releases/tag/v0.19.2), the `latest` tag points to the `0.19.2` tag.
86+
For example, if latest release is [v0.25.1](https://github.com/ignite/cli/releases/tag/v0.25.1), the `latest` tag points to the `0.25.1` tag.
8987

9088
### Specific version
9189

9290
You can specify to use a specific version of Ignite CLI. All available tags are in the [ignitehq/cli image](https://hub.docker.com/r/ignitehq/cli/tags?page=1&ordering=last_updated) on Docker Hub.
9391

9492
For example:
9593

96-
- Use `ignitehq/cli:0.19.2` (without the `v` prefix) to use version 0.15.1.
97-
- Use `ignitehq/cli:develop` to use the `develop` branch so you can experiment with the next version.
94+
- Use `ignitehq/cli:0.24.1` (without the `v` prefix) to use version 0.24.1.
95+
- Use `ignitehq/cli` to use the latest version.
96+
- Use `ignitehq/cli:develop` to use the `develop` branch so you can experiment with the upcoming version.
9897

9998
To get the latest image, run `docker pull`.
10099

0 commit comments

Comments
 (0)