django-visitor / docs / index.rst

Welcome to django-visitor's documentation!

Requirements

Django 1.1 or newer

Installation

Use pip to fetch the code:

pip install django-visitor

Make sure that that sessions are activated:

INSTALLED_APPS = (
    'django.contrib.sessions',
    ...
)

MIDDLEWARE_CLASSES = (
    'django.contrib.sessions.middleware.SessionMiddleware',
    ...
)

Add visitor to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'visitor',
)

Add the visitor middleware:

MIDDLEWARE_CLASSES = (
    ...
    'visitor.middleware.VisitorMiddleware'
    ...
)

Now load up the tables in your database:

python manage.py syncdb

Custom Settings

Add the following two properties to your settings file:

COOKIE_DOMAIN
    Default = None # Which means local domain only  www.domain.com but no funky.domain.com
    # if you want cookie to work across all subdomains, put '.domain.com'
    COOKIE_DOMAIN = None # .domain.com

COOKIE_MAX_AGE
    Default = 31536000 # or 1 year.
    # This is how long the cookie will live in your visitors browser before it expires on it's own
    COOKIE_MAX_AGE = 31536000 # 1 year

References

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.