summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorxengineering <mail2xengineering@protonmail.com>2021-06-18 10:00:10 +0200
committerxengineering <mail2xengineering@protonmail.com>2021-06-18 14:26:47 +0200
commit7634ee33120e7ef601ba1e806c63fe61c53e46bb (patch)
tree1a5225c9fefcc1bf69b143593c7c3001c0fbbc33 /README.md
parent52972b810a9a42cef5c88f9947d64a0705f243ac (diff)
downloadbirdscan-7634ee33120e7ef601ba1e806c63fe61c53e46bb.tar
birdscan-7634ee33120e7ef601ba1e806c63fe61c53e46bb.tar.zst
birdscan-7634ee33120e7ef601ba1e806c63fe61c53e46bb.zip
WIP: Implement Transport
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7ea1b71..e8f7716 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,50 @@
A software to take beautiful pictures of birds with a Raspberry Pi Camera.
+# Usage
+
+## Prepare the Target Fileserver
+
+TODO
+
+Some notes:
+```
+ssh-keygen -y -f ~/.ssh/id_rsa # generates and prints public key of this private one
+sudo mkdir /srv/birdscan
+sudo chown -R birdscan:birdscan /srv/birdscan
+sudo chmod -R 700 /srv/birdscan
+sudo setfacl -m u:myuser:rwx /srv/birdscan
+```
+
+## Install and configure birdscan on main Server
+
+Install and configure birdscan in these few steps on an Arch Linux system:
+
+```
+mkdir -p ~/ABS # create a directory for the arch build system
+cd ~/ABS
+git clone https://aur.archlinux.org/python-picamera.git # download picamera from AUR
+cd picamera
+makepkg -si # build and install picamera dependency
+mkdir ../birdscan
+cd ../birdscan
+# (download PKGBUILD for birdscan to current directory FIXME: insert link here)
+makepkg -si # build and install birdscan
+sudo ssh-keyscan -t rsa <fileserver_ip_or_host> >> /etc/ssh/ssh_known_hosts # add host key of fileserver
+sudo vim /etc/birdscan/config.json # edit config file
+sudo systemctl enable --now birdscan # start and enable birdscan
+```
+
+Change the configuration like this:
+
+```
+sudo vim /etc/birdscan/config.json
+sudo systemctl restart birdscan
+```
+
+If something does not work you can get a live log of birdscan like this:
+
+```
+journalctl -fu birdscan
+```
+