Skip to content

Commit 4b76c5d

Browse files
committed
Explain how to run Trinity through docker
1 parent 23ceaa8 commit 4b76c5d

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

docs/guides/trinity/quickstart.rst

+47
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,53 @@ Then, install the ``trinity`` package via pip:
5353
5454
pip3 install -U trinity
5555
56+
Installing through Docker
57+
-------------------------
58+
59+
Trinity can also be installed using ``Docker`` which can be a lightweight alternative where no
60+
changes need to be made to the host system apart from having ``Docker`` itself installed.
61+
62+
.. note::
63+
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.
66+
67+
Using ``Docker`` we have two different options to choose from.
68+
69+
70+
**1. Run an existing official image**
71+
72+
This is the default way of running Trinity through ``Docker``. If all we care about is running
73+
a Trinity node, using one of the latest released versions, this method is perfect.
74+
75+
Run:
76+
77+
.. code:: sh
78+
79+
docker run -it ethereum/trinity
80+
81+
Alternatively, we can run a specific image version, following the usual docker version schema.
82+
83+
.. code:: sh
84+
85+
docker run -it ethereum/trinity:0.1.0-alpha.13
86+
87+
**2. Build your own image**
88+
89+
Alternatively, we may want to try out a specific (unreleased) version. In that case, we can create
90+
our very own image directly from the source code.
91+
92+
93+
.. code:: sh
94+
95+
make create-docker-image version=my-own-version
96+
97+
After the images was built successfully we can run it by invoking:
98+
99+
.. code:: sh
100+
101+
docker run -it ethereum/trinity:my-own-version
102+
56103
Running Trinity
57104
~~~~~~~~~~~~~~~
58105

0 commit comments

Comments
 (0)