Metadata-Version: 1.1
Name: aldryn-sites
Version: 0.4
Summary: An extension for django.contrib.sites, featuring domain redirects and automatic population of the django.contrib.sites.Site table based on settings.
Home-page: https://github.com/aldryn/aldryn-sites/
Author: Stefan Foulis
Author-email: stefan@foulis.ch
License: BSD
Description: aldryn-sites
        ============
        
        .. image:: https://travis-ci.org/aldryn/aldryn-sites.svg?branch=develop
            :target: https://travis-ci.org/aldryn/aldryn-sites
        
        .. image:: https://img.shields.io/coveralls/aldryn/aldryn-sites.svg
          :target: https://coveralls.io/r/aldryn/aldryn-sites
        
        Extensions to django.contrib.sites.
        
        Features
        --------
        
        * **Domain redirects**: handles smart redirecting to a main domain from alias domains.
          Taking http/https into consideration.
        
        * **Site auto-population**: automatically populates the Domain name in ``django.contrib.sites.Site.domain`` based
          on the ``ALDRYN_SITES_DOMAINS`` setting.
        
        
        Installation
        ------------
        
        
        * add ``aldryn_sites`` to ``INSTALLED_APPS``.
        
        * add ``aldryn_sites.middleware.SiteMiddleware`` to ``MIDDLEWARE_CLASSES``
          (place it **before** ``djangosecure.middleware.SecurityMiddleware`` if redirects should be smart about alias domains
          possibly not having a valid certificate of their own. The middleware will pick up on ``SECURE_SSL_REDIRECT`` from
          ``django-secure``.)
          
        configure ``ALDRYN_SITES_DOMAINS``::
        
            ALDRYN_SITES_DOMAINS = {
                1: {  # matches SITE_ID
                    'domain': 'www.example.com',  # main domain that all the aliases will redirect to.
                                                  # Auto populates ``django.contrib.sites.Site.domain``
                    'aliases': [                  # these domains will be accessible like the main domain (no redirect).
                        'an.other.domain.com',
                        r'^[a-z0-9-]+\.anysub\.com$',  # regexes are supported
                    ],
                    'redirects': [                # these domains will be redirected to the main domain.
                        'example.com',            # add ``'*'`` to redirect all non-main domains to the main one.
                        'example.ch',
                        'www.example.ch',
                        r'^[a-z0-9-]+\.my-redirect-domain\.com$',  # regexes are supported
                    ],
                }
            }
        
        When using regexes:
        
        * exact matches win over pattern matches
        * pattern redirect matches win over pattern alias matches
        
        
        Further Settings
        ----------------
        
        set ``ALDRYN_SITES_SET_DOMAIN_NAME`` to ``False`` if you don't want ``django.contrib.sites.Site.domain`` to be
        auto-populated (default: ``True``).
        
        
        TODOS
        -----
        
        * validate settings
        * test settings validators
        * log warning if there are Sites in the database that are not in the settings
        * pretty display of how redirects will work (in admin and as a simple util)
        * regex support for aliases
        * form to test redirect logic
        * pre-compile and cache regexes
        
Platform: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
