https://github.com/ad/domru
domru domofon client
https://github.com/ad/domru
domofon domru golang homeassistant
Last synced: 11 months ago
JSON representation
domru domofon client
- Host: GitHub
- URL: https://github.com/ad/domru
- Owner: ad
- License: mit
- Created: 2020-06-12T17:10:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-23T05:25:14.000Z (almost 2 years ago)
- Last Synced: 2025-04-14T23:08:46.064Z (about 1 year ago)
- Topics: domofon, domru, golang, homeassistant
- Language: Go
- Homepage:
- Size: 485 KB
- Stars: 33
- Watchers: 3
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
**ad/domru** is inspired by [alexmorbo/domru](https://github.com/alexmorbo/domru), web server what allows you to control your domofon.
## 🚀 Installation and running
```shell
go get -u github.com/ad/domru
```
```shell
cp example.accounts.json accounts.json
domru -login=1234567890 -operator=2 -token=... -refresh=... -port=18000
```
## 🚀 Or Docker
```shell
cp example.accounts.json accounts.json
make build
docker run --name domru --rm -p 8080:18000 -e DOMRU_PORT=18000 -v $(pwd)/accounts.json:/share/domofon/account.json danielapatin/domru:latest
open http://localhost:8080/login
enter phone number in format 79xxxxxxxxx
choose your address
enter sms code, you will see received token and refresh token
restart docker container
docker run --name domru --rm -p 8080:18000 -e DOMRU_PORT=18000 -v $(pwd)/accounts.json:/share/domofon/account.json ad/domru:latest
now go to http://localhost:8080
```
## 🚀 Or Docker Compose
```
docker-compose up
the following instructions are the same
```
And open in browser [http://localhost:8080/snapshot](http://localhost:8080/snapshot)
## Docker image
You can find docker image in packages section of this github repository or pull it using `docker pull ghcr.io/ad/domru:latest`
## Endpoints and methods
| Endpoint | Method | Description |
| --- | --- | --- |
| `/` | GET | Main interface |
| `/login` | GET/POST | Auth interface |
| `/login/address` | POST | Get address by `phone` and `index` |
| `/sms` | POST | Request sms by `code` |
| `/cameras` | GET | Get list of camera |
| `/door` | GET/POST | Open door by `placeID` and `accessControlID` |
| `/events` | GET | Get list of events |
| `/events/last` | GET | Get last event |
| `/finances` | GET | Get finance info |
| `/operators` | GET | Get operators list |
| `/places` | GET | Get places list |
| `/snapshot` | GET | Get snapshot by `placeID` and `accessControlID` |
| `/stream` | GET | Get link to stream by `cameraID` |
## 🤝 Found a bug? Missing a specific feature?
Feel free to **file a new issue** with a respective title and description on the the [ad/domru](https://github.com/ad/domru/issues) repository. If you already found a solution to your problem, **we would love to review your pull request**!
## ✅ Requirements
Requires a **Go version higher or equal to 1.11**.
## 📘 License
Released under the terms of the [MIT License](LICENSE).