1 files changed, 51 insertions, 0 deletions
diff --git a/debian/README.Debian b/debian/README.Debian
new file mode 100644
index 0000000..7450383
--- /dev/null
+++ b/debian/README.Debian
@@ -0,0 +1,51 @@
+whiteboard for Debian
+=====================
+
+This package is the Debian version of whiteboard.
+
+It is a websocket application communicating to a webserver, e.g. Reichwein.IT webserver.
+
+Via cron or systemd, whiteboard data in /var/lib/whiteboard is cleaned up once a day.
+Data location and maximum data age can be configured via /etc/whiteboard.conf.
+
+Configuration
+-------------
+
+* You can add this to /etc/webserver.conf
+
+   <path requested="/whiteboard">
+    <plugin>static-files</plugin>
+    <target>/usr/lib/whiteboard/html</target>
+   </path>
+   <path requested="/whiteboard/websocket">
+    <plugin>websocket</plugin>
+    <target>127.0.0.1:9014</target>
+   </path>
+
+* Edit /etc/whiteboard.conf to adjust the whiteboard data path if different
+  from /var/lib/whiteboard
+
+* Enable:
+
+  # systemctl enable whiteboard.service
+
+* Start:
+
+  # systemctl start whiteboard
+
+* Stop:
+
+  # systemctl stop whiteboard
+
+* Query Status:
+
+  # systemctl status whiteboard
+
+  and observe /var/log/syslog
+
+
+Contact
+-------
+
+Reichwein IT <mail@reichwein.it>
+