Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sud335 committed Sep 8, 2016
1 parent e9737c5 commit d71ceef
Showing 1 changed file with 38 additions and 39 deletions.
77 changes: 38 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
BuildingDepot v3
=============
BuildingDepot v3.2.5
====================

BuildingDepot (BD) is a data sensor and actuation system for building management and control. It consists of a central server that uses a RESTful API to send (POST) and retrieve (GET) data. The typical data that BD stores is sensor data for buildings, including data from wireless sensor networks, existing SCADA systems, and other related data sources.

Expand All @@ -17,9 +17,6 @@ Installation

To install BD, run the install.sh script in the Installation folder. The default installation location is /srv.

Note:
This installer installs the BD DataService, CentralService, MongoDB, InfluxDB and Redis on the same machine.

1. Extract the package and cd into the folder**:

$ tar -xzf buildingdepot-3.#.#.tar.gz
Expand All @@ -38,37 +35,39 @@ buildingdepot
|-- CentralReplica - The central replica that is present at every DataService
+-- venv - Python Virtual Environment

* Note:
This installer installs the BD DataService, CentralService, MongoDB, InfluxDB and Redis on the same machine.The installer also requires requires Mail Transfer Agent or use Gmail APIs. The installer has an optional requirement to use SSL certificates.

What's installed
===============

The following packages are installed using apt-get

openssl
python-setuptools
python-dev
build-essential
python-software-properties
mongodb
python-pip
nginx
supervisor
redis-server
influxdb
The following packages are installed in the python virtual environment

Flask
mongoengine
flask-restful
Flask-HTTPAuth
flask-login
validate-email
requests
Flask-Script
Flask-WTF
flask-bootstrap
redis
influxdb
pymongo
* The following packages are installed using apt-get
* openssl
* python-setuptools
* python-dev
* build-essential
* python-software-properties
* mongodb
* python-pip
* nginx
* supervisor
* redis-server
* influxdb

* The following packages are installed in the python virtual environment
* Flask
* mongoengine
* flask-restful
* Flask-HTTPAuth
* flask-login
* validate-email
* requests
* Flask-Script
* Flask-WTF
* flask-bootstrap
* redis
* influxdb
* pymongo

Configuration
=============
Expand All @@ -77,14 +76,14 @@ The BD Installer configures BD with some default values.

The CentralService can be accessed on port 81 and the DataService on port 82.

DataService

To access the DataService, go to

URL - http://<host>:82

CentralService

To access the CentralService, go to

URL - http://<host>:81

DataService

To access the DataService, go to

URL - http://<host>:82

0 comments on commit d71ceef

Please sign in to comment.