Update README
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Lauri Võsandi 2023-08-26 21:20:37 +03:00
parent 6ad260078e
commit aa37e8e291

View File

@ -1,14 +1,35 @@
# GoDoor
[kdoorpi](https://git.k-space.ee/arti/kdoorpi) but in Go
Go rewrite of [kdoorpi](https://git.k-space.ee/arti/kdoorpi). Uses
[libgpiod](https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git/about/)
native Go library to access the general purpose pins in cross platform way.
Uses Go native [libgpiod](https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git/about/)
library to access the gpio pins in cross platform way.
# Developing
# Cross compile
Either build directly on Raspberry Pi or build locally and copy the binary
```
GOOS=linux GOARCH=arm64 go build
# Test deploy
scp godoor rpi4b:
```
# Deployment
The CI system should automatically build docker image and push it to [Harbor](https://harbor.k-space.ee)
Refer to
[Ansible playbook](https://git.k-space.ee/k-space/kube/src/branch/master/ansible-doors.yml)
on how to deploy on all door controllers
# Usage
For end users door can be opened by:
* [Web interface](https://inventory.k-space.ee/m/doorboy)
* Push button
* Enrolling keyfob and swiping keyfob at door cardreader
* Issuing `/open-...-door` command in #members channel
For emergency cases:
* Log into door controller via SSH and issue `killall -sUSR1 godoor`