Skip to content
This repository has been archived by the owner on Jan 18, 2019. It is now read-only.

Remove redundant Redis mentions #58

Open
wants to merge 1 commit into
base: docs
Choose a base branch
from
Open

Remove redundant Redis mentions #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions source/includes/_build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Run the script `run-iroha-dev.sh`, contained in the folder `scripts`: `sh .../ir
After you execute this script, following things happen:

1. The script checks if you don't have containers with Iroha already running. It ends up with reattaching you to interactive shell upon succesful completion.
2. The script will download iroha-docker-develop, redis and postgres images. Iroha image contains all development dependencies, and is based on top of ubuntu:16.04.
2. The script will download iroha-docker-develop and postgres images. Iroha image contains all development dependencies, and is based on top of ubuntu:16.04.
3. Three containers are created and launched.
4. The user is attached to the interactive environment for development and testing with `iroha` folder mounted from the host machine. Iroha folder is mounted to `/opt/iroha` in Docker container.

Expand Down Expand Up @@ -106,21 +106,17 @@ Execute `run-iroha-dev.sh` again to attach to existing container.

## Linux or macOS

> Launching Docker and Postgres in Docker
> Launching Postgres in Docker

``` shell
docker run --name some-redis \
-p 6379:6379 \
-d redis:3.2.8

docker run --name some-postgres \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=mysecretpassword \
-p 5432:5432 \
-d postgres:9.5
```

To launch Iroha daemon, running postgres and redis services are required. You may launch them on your local machine, or use docker containers, as provided on the right side.
To launch Iroha daemon, running postgres service is required. You may launch it on your local machine, or use docker container, as provided on the right side.

### Linux (debian-based)

Expand Down
24 changes: 11 additions & 13 deletions source/includes/_run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,16 @@ Follow JSON structure of the block, as it is reflected in [JSON schema for the b

Configuration file keeps information about storage credentials and irohad parameters:

| Parameter | Type | Meaning |
|-------------------|---------|-----------------------------------------------------------------------------------------------|
| block_store_path | string | Path to store blocks of committed transactions (flat file storage) |
| torii_port | integer | Port to access iroha node gRPC (default 50051) |
| Parameter | Type | Meaning |
|-------------------|---------|---------------------------------------------------------------------------------------------------------------------|
| block_store_path | string | Path to store blocks of committed transactions (flat file storage) |
| torii_port | integer | Port to access iroha node gRPC (default 50051) |
| internal_port | integer | Port for communication between ordering service, YAC consensus and block loader for synchronization (default 10001) |
| pg_opt | string | Postgres credentials |
| redis_host | string | Redis host IP address |
| redis_port | integer | Port to access redis storage |
| max_proposal_size | integer | Maximum size of created proposals |
| proposal_delay | integer | The period of time (in ms) used to prepare proposal of transactions |
| vote_delay | integer | The period of time (in ms) of spreading vote across the network |
| load_delay | integer | The period of time (in ms) between synchronizations between peers |
| pg_opt | string | Postgres credentials |
| max_proposal_size | integer | Maximum size of created proposals |
| proposal_delay | integer | The period of time (in ms) used to prepare proposal of transactions |
| vote_delay | integer | The period of time (in ms) of spreading vote across the network |
| load_delay | integer | The period of time (in ms) between synchronizations between peers |

Example:

Expand All @@ -77,9 +75,9 @@ To launch irohad daemon, following parameters must be passed:

| Parameter | Meaning |
|---------------|----------------------------------------------------------------------------------------------|
| config | configuration file, containing postgres, and redis connection, and values to tune the system |
| config | configuration file, containing postgres connection and values to tune the system |
| genesis_block | initial block in the ledger |
| keypair_name | private and public key file names without file extension. Used by peer to sign the blocks |
| keypair_name | private and public key file names without file extension. Used by peer to sign the blocks |

Use this command to launch iroha:

Expand Down