realorangeone / django-simple-robots

Simple robots.txt file serving for web applications

django-simple-robots

Most web applications shouldn't be indexed by Google. This app just provides a view that serves a "deny all" robots.txt.

In some cases, you do want your app to be indexed - but only in your production environment (not any staging environments). For this case, you can set ROBOTS_ALLOW_HOST. If the incoming hostname matches this setting, an "allow all" robots.txt will be served. Otherwise, the "deny all" will be served.

Tested against Django 2.2, 3.2 and 4.0 on Python 3.6, 3.7, 3.8, 3.9 and 3.10

Installation

Install from PIP

pip install django-simple-robots

In your root urlconf, add an entry as follows:

from django.conf.urls import url
from simple_robots.views import serve_robots

urlpatterns = [
    path("robots.txt", serve_robots),
    # ..... other stuff
]

Then, add simple_robots to INSTALLED_APPS in your settings.py

Optionally, set ROBOTS_ALLOW_HOST settings variable.

ROBOTS_ALLOW_HOST = "myproductionurl.com"

That's it!

Customization

The allow and disallow template are stored at robots.txt and robots-disallow.txt respectively. You can override these in your projects templates directory to customize the responses.

Code of conduct

For guidelines regarding the code of conduct when contributing to this repository please review https://www.dabapps.com/open-source/code-of-conduct/