Skip to content

Commit ecbc584

Browse files
authored
Docs: Fix Starting Container Instructions for RocksDB Iroha (#1600)
Signed-off-by: Sara <lira.lemur@gmail.com>
1 parent b77356a commit ecbc584

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/source/getting_started/index.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ Starting Iroha Node
3030

3131
Creating a Docker Network
3232
^^^^^^^^^^^^^^^^^^^^^^^^^
33-
To operate, Iroha requires a ``PostgreSQL`` database.
33+
To operate, Iroha requires a ``PostgreSQL`` database or ``RocksDB``.
34+
If you prefer ``PostgreSQL``, you will need a container running it alongside Iroha.
35+
36+
3437
Let's start with creating a Docker network, so containers for Postgres and
3538
Iroha can run on the same virtual network and successfully communicate.
3639
In this guide we will call it ``iroha-network``, but you can use any name.
@@ -43,6 +46,8 @@ In your terminal write following command:
4346
Starting PostgreSQL Container
4447
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4548

49+
.. note:: You do not need to start this container if your plan is to use Iroha with RocksDB and not PostgreSQL. Just skip to the next step.
50+
4651
Now we need to run ``PostgreSQL`` in a container, attach it to the network
4752
you have created before, and expose ports for communication:
4853

@@ -114,6 +119,8 @@ Let's start Iroha node in Docker container with the following command:
114119
-e KEY='node0' \
115120
hyperledger/iroha:latest
116121
122+
.. note:: If you are using Iroha with RocksDB, please add ``--entrypoint irohad`` to these parameters, to skip the PostgreSQL container check.
123+
117124
If you started the node successfully you would see the container id in the same console where you started the container.
118125

119126
Let's look in details what this command does:

0 commit comments

Comments
 (0)