Here the doc update to reflect the changes, clarifying the process.
From dd2d5ede04bc829aae646ff2f54d660e220e652b Mon Sep 17 00:00:00 2001 From: David Carlier <dcarl...@deviceatlas.com> Date: Wed, 2 Jul 2025 14:11:30 +0100 Subject: [PATCH 2/2] DOC: deviceatlas
Update accordingly the related documentation, removing/clarifying confusing parts as it was more complicated than it needed to be. --- doc/DeviceAtlas-device-detection.txt | 31 +++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/doc/DeviceAtlas-device-detection.txt b/doc/DeviceAtlas-device-detection.txt index 9df978377..26b5cb312 100644 --- a/doc/DeviceAtlas-device-detection.txt +++ b/doc/DeviceAtlas-device-detection.txt @@ -3,7 +3,9 @@ DeviceAtlas Device Detection In order to add DeviceAtlas Device Detection support, you would need to download the API source code from https://deviceatlas.com/deviceatlas-haproxy-module. -Once extracted : +Once extracted, two modes are supported : + +1/ Build HAProxy and DeviceAtlas in one command $ make TARGET=<target> USE_DEVICEATLAS=1 DEVICEATLAS_SRC=<path to the API root folder> @@ -14,10 +16,6 @@ directory. Also, in the case the api cache support is not needed and/or a C++ to $ make TARGET=<target> USE_DEVICEATLAS=1 DEVICEATLAS_SRC=<path to the API root folder> DEVICEATLAS_NOCACHE=1 -However, if the API had been installed beforehand, DEVICEATLAS_SRC -can be omitted. Note that the DeviceAtlas C API version supported is from the 3.x -releases series (3.2.1 minimum recommended). - For HAProxy developers who need to verify that their changes didn't accidentally break the DeviceAtlas code, it is possible to build a dummy library provided in the addons/deviceatlas/dummy directory and to use it as an alternative for the @@ -27,6 +25,29 @@ validate API changes : $ make TARGET=<target> USE_DEVICEATLAS=1 DEVICEATLAS_SRC=$PWD/addons/deviceatlas/dummy +2/ Build and install DeviceAtlas according to https://docs.deviceatlas.com/apis/enterprise/c/<release version>/README.html + +For example : +In the deviceatlas library folder : + $ cmake . + $ make + $ sudo make install + +In the HAProxy folder : + $ make TARGET=<target> USE_DEVICEATLAS=1 + +Note that if the -DCMAKE_INSTALL_PREFIX cmake option had been used, it is necessary to set as well DEVICEATLAS_LIB and +DEVICEATLAS_INC as follow : + $ make TARGET=<target> USE_DEVICEATLAS=1 DEVICEATLAS_INC=<CMAKE_INSTALL_PREFIX value>/include DEVICEATLAS_LIB=<CMAKE_INSTALL_PREFIX value>/lib + +For example : + $ cmake -DCMAKE_INSTALL_PREFIX=/opt/local + $ make + $ sudo make install + $ make TARGET=<target> USE_DEVICEATLAS=1 DEVICEATLAS_INC=/opt/local/include DEVICEATLAS_LIB=/opt/local/lib + +Note that DEVICEATLAS_SRC is omitted in this case. + These are supported DeviceAtlas directives (see doc/configuration.txt) : - deviceatlas-json-file <path to the DeviceAtlas JSON data file>. - deviceatlas-log-level <number> (0 to 3, level of information returned by -- 2.50.0
