https://github.com/isms/django-hide-herokuapp

Django app for Heroku users designed to hide your .herokuapp.com site from search engine results.
https://github.com/isms/django-hide-herokuapp

Last synced: 3 months ago
JSON representation

Django app for Heroku users designed to hide your .herokuapp.com site from search engine results.

• Host: GitHub
• URL: https://github.com/isms/django-hide-herokuapp
• Owner: isms
• License: mit
• Archived: true
• Created: 2015-03-10T13:18:17.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-05-09T16:15:59.000Z (over 8 years ago)
• Last Synced: 2024-07-21T19:56:15.360Z (4 months ago)
• Language: Python
• Homepage:
• Size: 10.7 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - django-hide-herokuapp - Django app for Heroku users designed to hide your .herokuapp.com site from search engine results. (Python)

README

        
django-hide-herokuapp

=====================

Django app for Heroku users designed to hide your ``*.herokuapp.com``

from search engine results.

.. image:: https://img.shields.io/pypi/v/django-hide-herokuapp.svg

    :target: https://pypi.python.org/pypi/django-hide-herokuapp

Use case

--------

You want to develop a website called ``artisanalraisinbeer.com`` using

Django deployed on Heroku. You write a little bit of Django code and

create a new Heroku app called ``artisanalraisinbeer`` to deploy to.

While developing, you can visit your site by going to this URL:

``http://artisanalraisinbeer.herokuapp.com``

Eventually, you finish the first version of your website, buy the

domain name `artisanalraisinbeer.com`, and set everything up

so that you can view the site just by going to the following URL:

``http://www.artisanalraisinbeer.com``

You can still visit ``http://artisanalraisinbeer.herokuapp.com``, which

is fine—but there's one problem: you want your main site to show

up in search results, *not* your ``.herokuapp.com`` site.

How it works

------------

This app goes about this two ways: `robots.txt `_

and the `X-Robots-Tag `_.

Why both? *To be double-plus sure...* :eyes:

If ``herokuapp`` seems to be in the `originating host`_

of the user request, then we do two things:

* Put the following in ``robots.txt``::

      User-agent: *

      Disallow: /

    

* Set ``X-Robots-Tag`` in our response header to ``noindex, nofollow``.

For search engines that respect these settings, they should start to ignore these sites

in future crawls.

Quick start

-----------

1. Add ``'hide_herokuapp'`` to your ``INSTALLED_APPS`` setting.

2. Add the ``HideHerokuappFromRobotsMiddleware`` middleware to your ``MIDDLEWARE_CLASSES``

   like this::

   

     MIDDLEWARE_CLASSES = (

         ...

         'hide_herokuapp.middleware.HideHerokuappFromRobotsMiddleware',

     )

   

3. Include the ``hide_herokuapp`` URLs in your project's ``urls.py`` like this::

   

      urlpatterns = [

         ...

         url(r'^', include('hide_herokuapp.urls')),

         ...

      ]

   

   alternatively, you may hook up the view directly::

      from hide_herokuapp.views import herokuapp_robots_view

      urlpatterns = [

        ...

        url(r'^robots\.txt$', herokuapp_robots_view),

        ...

      ] 

Contribute

----------

PyPI (Downloads)

    https://pypi.python.org/pypi/django-hide-herokuapp

Official repository

    https://github.com/isms/django-hide-herokuapp

Issue tracker

    https://github.com/isms/django-hide-herokuapp/issues

.. _originating host: https://docs.djangoproject.com/en/1.9/ref/request-response/#django.http.HttpRequest.get_host