README.md

August 21, 2025 ยท View on GitHub


GitHub license GitHub actions status

ad/domru is inspired by alexmorbo/domru, web server what allows you to control your domofon.

๐Ÿš€ย  Installation and running

go get -u github.com/ad/domru
cp example.accounts.json accounts.json
domru -login=1234567890 -operator=2 -token=... -refresh=... -port=18000

๐Ÿš€ย  Or Docker

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

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

EndpointMethodDescription
/GETMain interface
/loginGET/POSTAuth interface
/login/addressPOSTGet address by phone and index
/smsPOSTRequest sms by code
/camerasGETGet list of camera
/doorGET/POSTOpen door by placeID and accessControlID
/eventsGETGet list of events
/events/lastGETGet last event
/financesGETGet finance info
/operatorsGETGet operators list
/placesGETGet places list
/snapshotGETGet snapshot by placeID and accessControlID
/streamGETGet 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 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.24.

๐Ÿ“˜ย  License

Released under the terms of the MIT License.