github.com/e154/smart-home@v0.17.2-0.20240311175135-e530a6e5cd45/README.md (about) 1 <img width="100%" height="auto" src="doc/static/img/banner-v3.svg" alt="smart home logo"> 2 3 # The **Smart Home** 4 5 [](https://goreportcard.com/report/github.com/e154/smart-home) 6 [](https://www.gnu.org/licenses/gpl-3.0) 7 [](https://t.me/SmartHomGo) 8 9 |Branch |Status | 10 |------------|---------| 11 |master |  | 12 |dev |  | 13 |docs |  | 14 15 ### Overview 16 17 With the help of the software package **Smart Home** you can control many devices. Distributed network of devices based 18 on software package **Smart Home** has no geographical boundaries and allows manage devices anywhere in the Internet 19 through a system of nodes - microservices. You will be able to interact with these devices as if they were on your local 20 network. Create scripts and reactions to events in the web interface of the configurator through a flexible scripting 21 system. 22 23 The system does not require a permanent connection to the Internet, it is completely autonomous and has no dependencies 24 on external services. 25 26 The basic principles underlying the system being developed are ease of setup, low cost of content and accessibility of 27 the component base. 28 29 - [Features](#features) 30 - [Demo access](#demo-access) 31 - [Supported system](#supported-system) 32 - [Quick installation](#quick-installation) 33 - [Postgresql](#database-postgresql) 34 - [Docker](#docker) 35 - [Support](#support) 36 - [Contributors](#contributors) 37 - [See also](#see-also) 38 - [License](#license) 39 40 ### Features 41 42 1. The ultimate smart thing solution - server, configurator, gateway 43 2. Free and open source 44 3. Cross-platform Linux, MacOS, Windows ... 45 4. Convenient WEB-configurator for fine-tuning 46 5. Powerful visual interface editor 47 5. Organization of remote access without white IP FREE 48 6. Role system for separation of access rights 49 7. Plugin system 50 7. Programs in javaScript, coffeeScript, typeScript 51 8. Notification system SMS, Email, Slack, Telegram, Web push, html5 52 9. Embedded MQTT server/client/bridge 53 9. MODBUS, [ZIGBEE2MQTT](https://www.zigbee2mqtt.io/), rpc calling, etc 54 10. Autonomous system. 55 11. Telegram bots 56 11. Automation scenarios 57 11. Quick backup/recovery 58 12. Have Docker images to enhance system security 59 13. Minimum consumption of resources. 60 14. Optimized for embedded devices like Raspberry Pi 61 15. 100% local home automation 62 16. Create and restore full backups of your whole configuration with ease 63 17. Management web interface integrated into Smart home 64 65 ### Demo access 66 67 dashboard:<br /> 68 [dashboard](https://gate.e154.ru:8443) (https://gate.e154.ru:8443) <br /> 69 [dashboard](http://gate.e154.ru:8080) (http://gate.e154.ru:8080) <br /> 70 71 server id:<br /> 72 **cf4463fc-2f39-4271-a034-5c0c8087c56c** 73 74 user: admin@e154.ru <br /> 75 pass: admin 76 77 user: user@e154.ru <br /> 78 pass: user 79 80 openapi v3 spec:<br /> 81 [swagger](https://gate.e154.ru:8443/#/etc/swagger) (https://gate.e154.ru:8443/#/etc/swagger) 82 83 ### Supported system 84 85 * macOS 386 10.6 86 * macOS amd64 10.6 87 * linux 386 88 * linux amd64 89 * linux arm-5 90 * linux arm-6 91 * linux arm-7 92 * linux arm-64 93 * linux mips64 94 * linux mips64le 95 * windows 386 96 * windows amd64 97 98 Schematic smart home map 99 100 <img src="doc/static/img/smart-home-network.svg" alt="smart-home map" width="630"> 101 102 ### Database postgresql 103 104 [Installing PostgreSQL 15](https://e154.github.io/smart-home/docs/install/postgresql/) 105 106 ### Editing configuration files 107 108 ```bash 109 cp conf/config.dev.json conf/config.json 110 ``` 111 112 ### Main server install 113 114 Download the latest server version from [releases](https://github.com/e154/smart-home/releases) 115 116 show help options 117 ```bash 118 ./server-linux-amd64 help 119 ``` 120 121 run the server 122 ```bash 123 ./server-linux-amd64 124 ``` 125 126 ### Docker 127 128 ```bash 129 git clone https://github.com/e154/smart-home 130 cd smart-home 131 docker-compose up 132 ``` 133 134 It's all 135 136 ### Support 137 138 Smart home Wiki: [e154.github.io/smart-home](https://e154.github.io/smart-home/) 139 Bugs and feature requests: GitHub issues 140 141 ### Contributors 142 143 - [Alex Filippov](https://github.com/e154) 144 145 All the contributors are welcome. If you would like to be the contributor please accept some rules. 146 147 - The pull requests will be accepted only in "develop" branch 148 - All modifications or additions should be tested 149 150 Thank you for your understanding! 151 152 ### See also 153 154 * [OpenHub](https://www.openhab.org) 155 * [iridiummobile](http://www.iridiummobile.net) 156 * [amx](https://www.amx.com/en-US) 157 * [Home Assistant](https://www.home-assistant.io/integrations/) 158 * [Majordomo](https://majordomohome.com) 159 * [Domoticz](https://www.domoticz.com/) 160 161 ### LICENSE 162 163 [GPLv3 Public License](https://github.com/e154/smart-home/blob/master/LICENSE)