From baf360d303923e927f878929604975bdebd2eda0 Mon Sep 17 00:00:00 2001 From: Ben51Degrees Date: Thu, 5 Oct 2017 16:12:05 +0100 Subject: [PATCH] DOC: 51d: Update 51Degrees git URL to feature frozen branch and added instructions for getting Lite Hash Trie data file. --- doc/51Degrees-device-detection.txt | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/doc/51Degrees-device-detection.txt b/doc/51Degrees-device-detection.txt index 71b2eb760..3c70ab669 100644 --- a/doc/51Degrees-device-detection.txt +++ b/doc/51Degrees-device-detection.txt @@ -14,7 +14,7 @@ headers as configurable parameters. In order to enable 51Degrees download the 51Degrees source code from the official github repository : - git clone https://git.51Degrees.com/Device-Detection.git -b v3.2.10 + git clone https://git.51Degrees.com/Device-Detection.git -b v3.2.12 then run 'make' with USE_51DEGREES and 51DEGREES_SRC set. Both 51DEGREES_INC and 51DEGREES_LIB may additionally be used to force specific different paths @@ -24,22 +24,22 @@ for .o and .h, but will default to 51DEGREES_SRC. Make sure to replace 51Degrees provide 2 different detection algorithms: 1. Pattern - balances main memory usage and CPU. - 2. Trie - a very high performance detection solution which uses more main - memory than Pattern. + 2. Hash Trie - a very high performance detection solution. To make with 51Degrees Pattern algorithm use the following command line. $ make TARGET= USE_51DEGREES=1 51DEGREES_SRC='51D_REPO_PATH'/src/pattern -To use the 51Degrees Trie algorithm use the following command line. +To use the 51Degrees Hash Trie algorithm use the following command line. $ make TARGET= USE_51DEGREES=1 51DEGREES_SRC='51D_REPO_PATH'/src/trie A data file containing information about devices, browsers, operating systems and their associated signatures is then needed. 51Degrees provide a free -database with Github repo for this purpose. These free data files are located -in '51D_REPO_PATH'/data with the extensions .dat for Pattern data and .trie for -Trie data. +database with Github repo for this purpose. The free Pattern data file is located +in '51D_REPO_PATH'/data with the extension .dat. A Free Hash Trie data file can +be obtained by signing up for a licence key at: + https://51degrees.com/products/store/on-premise-device-detection. The configuration file needs to set the following parameters: @@ -103,14 +103,17 @@ uses the User-Agent HTTP header only for detection. Any HTTP header could be used inplace of User-Agent by changing the parameter provided to req.fhdr. -When compiled to use the Trie detection method the trie format data file needs -to be provided. Changing the extension of the data file from dat to trie will -use the correct data. +When compiled to use the Hash Trie detection method the trie format data file +needs to be provided. Changing the extension of the data file from dat to trie +will use the correct data. global - 51degrees-data-file '51D_REPO_PATH'/data/51Degrees-LiteV3.2.trie + 51degrees-data-file '51D_REPO_PATH'/data/51Degrees-LiteV3.4.trie -When used with Trie the Method, Difference and Rank properties are not +Note that old V3.2 Trie data files are no longer supported. The V3.4 Hash Trie +data files should instead be used. + +When used with Hash Trie the Method, Difference and Rank properties are not available. The free Lite data file contains information about screen size in pixels and -- 2.12.0.windows.1