Begin README

This commit is contained in:
Tanner
2025-10-14 22:19:18 +01:00
parent 924fdf9542
commit 9b4d29452b

44
README.md Normal file
View File

@@ -0,0 +1,44 @@
# Protoflap
Controls the welcome room Vestaboard directly, bypassing their cloud.
## Setup
### Supervisor
Install supervisor:
```
# apt install supervisor
# touch /etc/supervisor/conf.d/protoflap.conf
# vim /etc/supervisor/conf.d/protoflap.conf
```
Set config to:
```
[program:protoflap]
user=root
directory=/root/protoflap
command=/usr/bin/python /root/protoflap/protoflap.py
stopsignal=INT
stopasgroup=true
killasgroup=true
autostart=true
autorestart=true
stderr_logfile=/var/log/protoflap.log
stderr_logfile_maxbytes=10MB
stdout_logfile=/var/log/protoflap.log
stdout_logfile_maxbytes=10MB
```
Load changes:
```
# supervisorctl reread; supervisorctl update
```