Merge pull request #153 from hyperledger/develop

Adding documentation, merge develop into master
hyperledger · Feb 7, 2017 · 3d442ad · 3d442ad
2 parents 9bc0500 + f6cb80c
commit 3d442ad
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -12,11 +12,12 @@
 Please include a developer certificate with pull requests: https://www.clahub.com/agreements/hyperledger/iroha
 
 # Documentation
- - [Architecture.](./docs/architecture.md)
+ - [Architecture](./docs/architecture.md)
  - [Build iroha in local environment](./docs/how_to_build.rst)
  - [Using docker to build iroha container](./docker/README.md)
  - [Using docker-compose to setup test network of N nodes on a single computer](./docs/docker_compose.md)
  - [Deploying a network of N nodes using docker swarm](./docs/docker_swarm.md)
+ - [Deploying a network of N nodes without docker swarm](./docs/iroha_network.md)
 
 # Authors
 

diff --git a/docs/iroha_network.md b/docs/iroha_network.md
@@ -0,0 +1,46 @@
+# How to run network of N iroha nodes without docker swarm?
+
+1. Make sure you have the latest `iroha-docker` image:
+
+   ````
+   docker pull hyperledger/iroha-docker
+   ````
+
+2. On each node create ***correct*** `sumeragi.json`:
+
+   - double check all ip addresses
+   - double check all public keys
+
+   Save it somewhere (we assume it is in `/tmp/sumeragi.json` on each node).
+
+3. Run `iroha-docker` on each node:
+
+   ```bash
+   # beware of copy-pasting: change /tmp/sumeragi.json to location of this file in host OS
+   docker run \
+     -d \
+     -p 1204:1204 \
+     -it \
+     -v /tmp/sumeragi.json:/usr/local/iroha/config/sumeragi.json \
+     hyperledger/iroha-docker
+   ```
+
+   ```bash
+   # semantics:
+   -d                        -- detached (from terminal)
+   -p 1204:1204              -- forward port: host 1204 <-> 1204 container
+                                docker proxy will be listening on 0.0.0.0:1204 and 
+                                it will be forwarding all traffic to the container
+   -it                       -- not necessary but help us to get rid of some errors
+                                i - keep STDIN open even if not attached
+                                t - allocate TTY
+   -v /tmp/sumeragi.json:/usr/local/iroha/config/sumeragi.json 
+                             -- mount config from host to container 
+                                (semantics: -v from:to, only absolute paths)
+   hyperledger/iroha-docker  -- image tag
+   ```
+
+   
+
+In the end, you have a network of N nodes, you can communicate with them via host IPs. Each node from this moment runs iroha as if you use it without docker.
+