Skip to content

Commit 6db668f

Browse files
committed
Add docs on Docker support
1 parent 4b76c5d commit 6db668f

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,24 @@ git push && git push --tags
112112
make release
113113
```
114114

115+
To create a docker image:
116+
117+
```sh
118+
make create-docker-image version=<version>
119+
```
120+
121+
By default, this will create a new image with two tags pointing to it:
122+
- `ethereum/trinity:<version>` (explicit version)
123+
- `ethereum/trinity:latest` (latest until overwritten with a future "latest")
124+
125+
Then, push to docker hub.
126+
127+
```sh
128+
docker push ethereum/trinity:<version>
129+
# the following may be left out if we were pushing a patch for an older version
130+
docker push ethereum/trinity:latest
131+
```
132+
115133

116134
#### How to bumpversion
117135

docs/guides/trinity/quickstart.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ changes need to be made to the host system apart from having ``Docker`` itself i
6161

6262
.. note::
6363
While we don't officially support Windows just yet, running Trinity through ``Docker`` is a great
64-
way to bypass this current limitation as Trinity can run on any system that runs ``Docker``,
65-
including Windows.
64+
way to bypass this current limitation as Trinity can run on any system that runs ``Docker`` [with
65+
support for linux containers](https://docs.docker.com/docker-for-windows/#switch-between-windows-and-linux-containers).
6666

6767
Using ``Docker`` we have two different options to choose from.
6868

@@ -94,7 +94,7 @@ our very own image directly from the source code.
9494
9595
make create-docker-image version=my-own-version
9696
97-
After the images was built successfully we can run it by invoking:
97+
After the image has been successfully created, we can run it by invoking:
9898

9999
.. code:: sh
100100

0 commit comments

Comments
 (0)