afb-hreq.c: fix etag size (fixes stack smashing detected by stack protector)

[src/app-framework-binder.git] / README.md

diff --git a/README.md b/README.md
index 0cfc8da..df4d33e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,33 +9,67 @@ Final goal is to keep the engine publicly accessible and modifiable, still allow
 Finally, whatever license is chosen, it should be compatible with dependencies and automotive industry requirements - as the primary target for this code is AGL. 
 
 ### Building
-Building Application Framework Binder requires the following libraries:
- * libmagic ("libmagic-dev" under Debian/Ubuntu, "file-devel" under OpenSUSE);
- * libmicrohttpd ("libmicrohttpd-dev/devel");
+Building Application Framework Binder has been tested under **Ubuntu 16.04 LTS (Xenial Xerus)** or **Fedora 23**, and requires the following libraries:
+ * libmagic ("libmagic-dev" under Ubuntu, "file-devel" under Fedora);
+ * libmicrohttpd >= 0.9.48  (fetch and build from "http://ftp.gnu.org/gnu/libmicrohttpd");
  * json-c ("libjson-c-dev/devel");
  * uuid ("uuid-dev/libuuid-devel");
- * dbus ("libdbus-1-dev/dbus-1-devel");
+ * openssl ("libssl-dev/openssl-devel");
+ * systemd >= 222 ("libsystemd-dev/systemd-devel");
 
 optionally, for plugins :
  * alsa ("libasound2-dev/alsa-devel");
  * pulseaudio ("libpulse-dev/libpulse-devel");
- * rtl-sdr >= 0.5.0 (fetch and build from "git://git.osmocom.org/rtl-sdr");
+ * rtl-sdr >= 0.5.0 ("librtlsdr-dev", or fetch and build from "git://git.osmocom.org/rtl-sdr" under Fedora);
  * GUPnP ("libglib2.0-dev libgupnp-av-1.0-dev/glib2-devel libgupnp-av-devel");
 
+Libmicrohttpd should be v49 patched or higher version including patch 5583
+ * Prepatched v49 for AGL is avaliable at http://iot.bzh/download/public/2016/afb-demos/libmicrohttpd-0.9.49-agl.tgz
+ * Bug is described at https://gerrit.automotivelinux.org/gerrit/#/c/5583/
+
+
 and the following tools:
+ * gcc;
+ * make;
  * pkg-config;
  * cmake >= 2.8.8.
 
-To install all dependencies under OpenSUSE (excepting rtl-sdr), please type:
+To install all dependencies under Ubuntu (excepting libmicrohttpd), please type:
+```
+$ apt-get install libmagic-dev libjson-c-dev uuid-dev libsystemd-dev libssl-dev libasound2-dev libpulse-dev librtlsdr-dev libglib2.0-dev libgupnp-av-1.0-dev gcc make pkg-config cmake
+```
+or under Fedora (excepting libmicrohttpd and rtl-sdr):
 ```
-$ zypper in file-devel libmicrohttpd-devel libjson-c-devel libuuid-devel dbus-1-devel alsa-devel libpulse-devel glib2-devel libgupnp-av-devel pkg-config cmake
+$ dnf install git passwd iproute openssh-server openssh-client openssh-server # Tools needed on top of Docker Minimal Fedora
+$ dnf install file-devel gcc gdb make pkgconfig cmake  # install gcc developement tool chain + cmake
+$ dnf install file-devel json-c-devel libuuid-devel systemd-devel openssl-devel 
+$ dnf install alsa-lib-devel pulseaudio-libs-devel glib2-devel gupnp-av-devel # optional but require to build audio plugin
 ```
 
- To build, move to the root directory and type:
+ To build, move to your HOME directory and type:
 ```
+$ export LIBMICRODEST= /opt/libmicrohttpd-0.9.49-agl
+$ wget http://iot.bzh/download/public/2016/afb-demos/libmicrohttpd-0.9.49-agl.tgz
+$ tar -xzf libmicrohttpd-0.9.49-agl.tgz
+$ cd libmicrohttpd-0.9.49-agl
+$ ./configure --prefix=$LIBMICRODEST
+$ make
+$ sudo make install-strip
+
+$ git clone https://github.com/iotbzh/afb-daemon.git
+$ cd afb-daemon
 $ mkdir build; cd build<br />
+$ export PKG_CONFIG_PATH=$LIBMICRODEST/lib/pkgconfig 
 $ cmake ..<br />
-$ make; make install<br />
+$ make; 
+$ sudo make install<br />
+```
+
+### Testing/Debug
+```
+$ AFB_DAEMON_DIR=$HOME/afb-daemon
+$ $AFB_DAEMON_DIR/build/src/afb-daemon --help
+$ $AFB_DAEMON_DIR/build/src/afb-daemon --port=1234 --token='' --ldpaths=$AFB_DAEMON_DIR/build --sessiondir=/tmp --rootdir=$AFB_DAEMON_DIR/test 
 ```
 
 ### Starting