diff --git a/README.md b/README.md index d445abd4c1..d0def0d933 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,21 @@ # Thingsboard +Thingsboard is an open-source IoT platform for data collection, processing, visualization, and device management. -## Introduction - -Tningsboard is an open-source IoT platform for data collection, processing, visualization, and device management. - -![Dashboard](./img/dashboard.gif?raw=true "Real-time Fleet Dashboard") - - -## Community - - -## Contribute +## Documentation +Thingsboard documentation is hosted on http://thingsboard.io. ## Support - -## Docker usage - -**start platform using docker:** -- install docker -- cd to 'docker' folder -- create folder for cassandra data directory on your local env (host) - - `mkdir /home/user/data_dir` -- modify .env file to point to the directory created in previous step -- start ./deploy.sh script to run all the services - - -**start-up for local development** - -cassandra with thingsboard schema (9042 and 9061 ports are exposed). -zookeper services (2181 port is exposed). -9042, 9061 and 2181 ports must be free so 'Thingsboard' server that is running outside docker container is able to connect to services. -you can change these ports in docker-compose.static.yml file to some others, but 'Thingsbaord' application.yml file must be updated accordingly. -if you would like to change cassandra port, change it to "9999:9042" for example and update cassandra.node_list entry in application.yml file to localhost:9999. - -- install docker -- cd to 'docker' folder -- create folder for cassandra data directory on your local env (host) - - `mkdir /home/user/data_dir` -- modify .env file to point to the directory created in previous step -- start ./deploy_cassandra_zookeeper.sh script to run cassandra with thingsboard schema and zookeper services -- Start boot class: _org.thingsboard.server.ThingsboardServerApplication_ + - [Community chat](https://gitter.im/thingsboard/chat) + - [Q&A forum](https://groups.google.com/forum/#!forum/thingsboard) + - [Stackoverflow](http://stackoverflow.com/questions/tagged/thingsboard) ## Licenses -This project is released under [Apache 2.0 license](./LICENSE). \ No newline at end of file +This project is released under [Apache 2.0 license](./LICENSE). + +![Dashboard](./img/dashboard.gif?raw=true "Real-time Fleet Dashboard") \ No newline at end of file