Skip to content

Latest commit

 

History

History
110 lines (99 loc) · 2.89 KB

installation.md

File metadata and controls

110 lines (99 loc) · 2.89 KB
Raw

The following document is a step-by-step guide to run BCHWS.

Prerequisites

Ensure MongoDB (2.6+) is installed and running. This document assumes that mongod is running at the default port 27017. See the configuration section to configure a different host/port.

Install BCHWS from NPM

Use the following steps to Install BCHWS from the npmjs repository and run it with defaults.

npm install bch-wallet-service
cd bch-wallet-service

To change configuration before running, see the Configuration section.

npm start

Install BCHWS from github source

Use the following steps to Install BCHWS from github source and run it with defaults.

git clone https://github.com/owstack/bch-wallet-service.git
cd bch-wallet-service
npm install

To change configuration before running, see the Configuration section.

npm start

Configuration

Configuration for all required modules can be specified in https://github.com/owstack/bch-wallet-service/blob/master/config.js

BCHWS is composed of 5 separate node services - Locker - locker/locker.js Message Broker - messagebroker/messagebroker.js Blockchain Monitor - bcmonitor/bcmonitor.js (This service talks to the Blockchain Explorer service configured under blockchainExplorerOpts - see Configure blockchain service below.) Email Service - emailservice/emailservice.js Bch Wallet Service - bchws.js

Configure MongoDB

Example configuration for connecting to the MongoDB instance:

  storageOpts: {
    mongoDb: {
      uri: 'mongodb://localhost:27017/bchws',
    },
  }

Configure Locker service

Example configuration for connecting to locker service:

  lockOpts: {
    lockerServer: {
      host: 'localhost',
      port: 4231,
    },
  }

Configure Message Broker service

Example configuration for connecting to message broker service:

  messageBrokerOpts: {
    messageBrokerServer: {
      url: 'http://localhost:3381',
    },
  }

Configure blockchain service

Note: this service will be used by blockchain monitor service as well as by BCHWS itself. An example of this configuration is:

  blockchainExplorerOpts: {
    defaultProvider: 'explorer',

    // Providers
    'explorer': {
      'livenet': {
        url: 'https://explorer.openwalletstack.com:443',
        apiPrefix: '/explorer-api'
      },
      'testnet': {
        url: 'https://test-explorer.openwalletstack.com:443',
        apiPrefix: '/explorer-api'
      }
    }
  }

Configure Email service

Example configuration for connecting to email service (using postfix):

  emailOpts: {
    host: 'localhost',
    port: 25,
    ignoreTLS: true,
    subjectPrefix: '[Wallet Service]',
    from: 'wallet-service@openwalletstack.com',
  }

Enable clustering

Change config.js file to enable and configure clustering:

{
  cluster: true,
  clusterInstances: 4,
}