From 2eb5fdded1b9e311accae4c0728d4649de0f44de Mon Sep 17 00:00:00 2001
From: Pierre Balzack <96387156+balzack@users.noreply.github.com>
Date: Wed, 24 Jan 2024 14:31:57 -0800
Subject: [PATCH] Create openwrt.md

---
 doc/openwrt.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 doc/openwrt.md

diff --git a/doc/openwrt.md b/doc/openwrt.md
new file mode 100644
index 000000000..e6c698191
--- /dev/null
+++ b/doc/openwrt.md
@@ -0,0 +1,25 @@
+# HowTo include Databag in an OpenWrt firmware image
+
+These instructions assume can build an OpenWrt firmware for your hardware:
+  - guide: [https://openwrt.org/docs/guide-developer/start](https://openwrt.org/docs/guide-developer/toolchain/use-buildsystem)
+  - you will likely also want to install nginx and configure it as a reverse proxy to the databag service
+
+## Databag is currently included as a custom feed
+  - in feed.conf at the root of the repository add:
+  -     src-git databag https://github.com/balzack/databag.git
+  - update the package list by running:
+  -     scripts/feeds update databag
+  - install the pacakge by running:
+  -     scripts/feeds install databag
+  - include the pacakge in the firmware by running:
+  -     make menuconfig
+  - enable databag under net/instant messaging/databag
+  - build the firmware by running:
+  -     make -j1 V=s package/databag/compile
+  - flash and boot the resulting image
+
+## Configure the Databag service
+  - change the port as desired
+  -     uci set databag.@databag[0].service_port='<port>'
+  - change the storage path to your mounted USB path
+  -     uci set databag.@databag[0].store_path='<path>'