Check out the latest documentation.

Config

The configuration file is created when the following command is executed. Note* You do not need the configuration file if using Django, these settings will put in settings.py. 

										
										$ 
										
									51degrees-mobile-detector settings > 
										
										$HOME
										
									/51degrees-mobile-detector.settings.py

Below is the configuration file with all the variables that you may want to change, such as the detection method. Important: Please note that the comments on for this configuration file are a bit outdated and will be changed in the near future. Please read the following carefully as it outlines major changes to the config file. Please also read if you are planning to use the Trie method.

  • DETECTION_METHOD - setting can now have only two choices: v3-wrapper and v3-trie-wrapper . Make sure you specify the path to Data File correctly for whatever detection method you have chosen. If you have a Premium or Enterprise data file specify a path to that file to get access to more device properties.
  • TRIE_WRAPPER_DATABASE is the parameter generated by default, please rename it to V3_TRIE_WRAPPER_DATABASE if you are planning to use trie matching.
  • V3_TRIE_WRAPPER_DATABASE - is the path to the Trie data file. The path is relative to the location of the directory the configuration file is in. It's best to use relative path and not an absolute path. For example: if you have a directory called Website which contains data the file and another directory inside the website directory called settings which contains the configuration file. Then you would specify the path to the Trie file as "../51Degrees.trie".
  • V3_WRAPPER_DATABASE - is the path to the data file. The path is relative to the location of the directory the configuration file is in. It's best to use relative path and not an absolute path. For example: if you have a directory called Website which contains data the file and another directory inside the website directory called settings which contains the configuration file. Then you would specify the path to the data file as "../51Degrees.dat". 

										
										# -*- coding: utf-8 -*-
										
										
										'''
										
										
										Default 51Degrees Mobile Detector settings. Override these using the
										
										
										FIFTYONE_DEGREES_MOBILE_DETECTOR_SETTINGS environment variable. Both file
										
										
										paths (e.g. '/etc/51degrees-mobile-detector.settings.py') and module
										
										
										names (e.g. 'myproject.fiftyone_degrees_mobile_settings') are allowed.
										
										
										If not specified, defaults to '51degrees-mobile-detector.settings.py'
										
										
										in the current working directory.
										
										
										Note that when using the mobile detector in a Django project, settings
										
										
										can also be specified using the FIFTYONE_DEGREES_MOBILE_DETECTOR_SETTINGS
										
										
										variable in the Django settings file.
										
										
										:copyright: (c) 2013 by 51Degrees.mobi, see README.rst for more details.
										
										
										:license: MPL2, see LICENSE.txt for more details.
										
										
										'''
										
										
										from
										
										
										__future__
										
										
										import
										
									 absolute_import


										
										###############################################################################
										
										
										## GENERAL SETTINGS.
										
										
										###############################################################################
										
										
										# Sets the preferred mobile device detection method. Available options are:
										
										
										#
										
										
										#   - 'lite-pattern-wrapper': Requires '51degrees-mobile-detector-lite-pattern-wrapper' package.
										
										
										#   - 'premium-pattern-wrapper': Requires '51degrees-mobile-detector-premium-pattern-wrapper' package.
										
										
										#   - 'trie-wrapper': Requires '51degrees-mobile-detector-trie-wrapper' package.
										
										
										#
										
									
DETECTION_METHOD 
										
										=
										
										
										'v3-trie-wrapper'
										
										
										# List of case-sensitive property names to be fetched on every device detection. Leave empty to
										
										
										# fetch all available properties.
										
									
PROPERTIES 
										
										=
										
									 ()


										
										# Your 51Degrees license key. This is required if you want to set up the automatic
										
										
										# 51degrees-mobile-detector-premium-pattern-wrapper package updates.
										
									
LICENSE 
										
										=
										
										
										''
										
										
										###############################################################################
										
										
										## TRIE DETECTOR (C WRAPPER) SETTINGS.
										
										
										###############################################################################
										
										
										# Location of the database file. If not specified, the trie-based detection
										
										
										# method will not be available. Download the latest 51Degrees.mobi-Lite-*.trie.zip
										
										
										# file from http://sourceforge.net/projects/fiftyone-c/files/.
										
										
										# TRIE_WRAPPER_DATABASE must be renamed to V3_TRIE_WRAPPER_DATABASE.
										
									
V3_TRIE_WRAPPER_DATABASE 
										
										=
										
										
										'51Degrees.trie'
										
										
										###############################################################################
										
										
										## V3 DETECTOR (C WRAPPER) SETTINGS.
										
										
										###############################################################################
										
										
										# Location of the database file. If not specified, the trie-based detection
										
										
										# method will not be available. Download the latest 51Degrees.mobi-Lite-*.trie.zip
										
										
										# file from http://sourceforge.net/projects/fiftyone-c/files/.
										
									
V3_WRAPPER_DATABASE 
										
										=
										
										
										'51Degrees-Lite.dat'
										
										
										###############################################################################
										
										
										## USAGE SHARER SETTINGS.
										
										
										###############################################################################
										
										
										# Indicates if usage data should be shared with 51Degrees.mobi. We recommended
										
										
										# leaving this value unchanged to ensure we're improving the performance and
										
										
										# accuracy of the solution.
										
									
USAGE_SHARER_ENABLED 
										
										=
										
										
										True
										
										
										# The detail that should be provided relating to new devices.
										
										
										# Modification not required for most users.
										
									
USAGE_SHARER_MAXIMUM_DETAIL 
										
										=
										
										
										True
										
										
										# URL to send new device data to.
										
										
										# Modification not required for most users.
										
									
USAGE_SHARER_SUBMISSION_URL 
										
										=
										
										
										'http://devices.51degrees.mobi/new.ashx'
										
										
										# Data submission timeout (seconds).
										
									
USAGE_SHARER_SUBMISSION_TIMEOUT 
										
										=
										
										
										10
										
										
										# Minimum queue length to launch data submission.
										
									
USAGE_SHARER_MINIMUM_QUEUE_LENGTH 
										
										=
										
										
										50
										
										
										# Used to detect local devices.
										
										
										# Modification not required for most users.
										
									
USAGE_SHARER_LOCAL_ADDRESSES 
										
										=
										
									 (
    
										
										'127.0.0.1'
										
									,
    
										
										'0:0:0:0:0:0:0:1'
										
									,
)


										
										# The content of fields in this list should not be included in the
										
										
										# request information sent to 51Degrees.
										
										
										# Modification not required for most users.
										
									
USAGE_SHARER_IGNORED_HEADER_FIELD_VALUES 
										
										=
										
									 (
    
										
										'Referer'
										
									,
    
										
										'cookie'
										
									,
    
										
										'AspFilterSessionId'
										
									,
    
										
										'Akamai-Origin-Hop'
										
									,
    
										
										'Cache-Control'
										
									,
    
										
										'Cneonction'
										
									,
    
										
										'Connection'
										
									,
    
										
										'Content-Filter-Helper'
										
									,
    
										
										'Content-Length'
										
									,
    
										
										'Cookie'
										
									,
    
										
										'Cookie2'
										
									,
    
										
										'Date'
										
									,
    
										
										'Etag'
										
									,
    
										
										'If-Last-Modified'
										
									,
    
										
										'If-Match'
										
									,
    
										
										'If-Modified-Since'
										
									,
    
										
										'If-None-Match'
										
									,
    
										
										'If-Range'
										
									,
    
										
										'If-Unmodified-Since'
										
									,
    
										
										'IMof-dified-Since'
										
									,
    
										
										'INof-ne-Match'
										
									,
    
										
										'Keep-Alive'
										
									,
    
										
										'Max-Forwards'
										
									,
    
										
										'mmd5'
										
									,
    
										
										'nnCoection'
										
									,
    
										
										'Origin'
										
									,
    
										
										'ORIGINAL-REQUEST'
										
									,
    
										
										'Original-Url'
										
									,
    
										
										'Pragma'
										
									,
    
										
										'Proxy-Connection'
										
									,
    
										
										'Range'
										
									,
    
										
										'Referrer'
										
									,
    
										
										'Script-Url'
										
									,
    
										
										'Unless-Modified-Since'
										
									,
    
										
										'URL'
										
									,
    
										
										'UrlID'
										
									,
    
										
										'URLSCAN-ORIGINAL-URL'
										
									,
    
										
										'UVISS-Referer'
										
									,
    
										
										'X-ARR-LOG-ID'
										
									,
    
										
										'X-Cachebuster'
										
									,
    
										
										'X-Discard'
										
									,
    
										
										'X-dotDefender-first-line'
										
									,
    
										
										'X-DRUTT-REQUEST-ID'
										
									,
    
										
										'X-Initial-Url'
										
									,
    
										
										'X-Original-URL'
										
									,
    
										
										'X-PageView'
										
									,
    
										
										'X-REQUEST-URI'
										
									,
    
										
										'X-REWRITE-URL'
										
									,
    
										
										'x-tag'
										
									,
    
										
										'x-up-subno'
										
									,
    
										
										'X-Varnish'
										
									,
)

Chapters