Django Static

Note

Note to myself… None of my projects use the staticfiles_urlpatterns function, but they still serve static files… but I cannot see how!!

The Django documentation describes a helper function, staticfiles_urlpatterns, for serving static files during development:

from django.contrib.staticfiles.urls import staticfiles_urlpatterns

urlpatterns = patterns(
    '',
    url(regex=r'^admin/',
        view=include(admin.site.urls)
        ),
)

urlpatterns += staticfiles_urlpatterns()

Note

This helper function will only work if DEBUG is True

Compress

Warning

31/10/2016 We have removed django_compressor from the projects. We will use another JS based tool when we need it. For further information, see tickets 1009 and 1814 and https://github.com/pkimber/base/commit/a84f4c8a2d84857be8a824fe165c610ac39c9135

Note

The fabric deploy task runs the compress management command for all projects which use Amazon web services (unless you use the compress setting in your pillar).

Tip

For issues, see Issues

http://django-compressor.readthedocs.org/:

# requirements/base.txt

django-compressor==1.4

# settings/base.py

STATICFILES_FINDERS = (
    ...
    'compressor.finders.CompressorFinder',
)

THIRD_PARTY_APPS = (
    'compressor',

# settings/local.py

STATIC_URL = '/static/'

Setup your site to use Amazon S3, Amazon S3.

# settings/production.py

# http://stackoverflow.com/questions/10929418/django-compressor-with-s3-url-heroku
AWS_QUERYSTRING_AUTH = False
AWS_PRELOAD_METADATA = True

# django-compressor
COMPRESS_ENABLED = True
COMPRESS_OFFLINE = True
COMPRESS_STORAGE = 'base.storage.CachedS3BotoStorage'
COMPRESS_URL = 'http://{}{}.s3.amazonaws.com/'.format(
    SITE_NAME.replace('_', '-'),
    '-test' if TESTING else '',
)
STATIC_URL = COMPRESS_URL
COMPRESS_ROOT = STATIC_ROOT
STATICFILES_STORAGE = COMPRESS_STORAGE

If you are hosting your site on Amazon and don’t want to use Django Compressor (perhaps you are writing an API and don’t have any templates):

# optional - to disable

# django-compressor
COMPRESS_ENABLED = False # defaults to the opposite of DEBUG

Add compress: False to your site pillar e.g:

hatherleigh_info:
  amazon: True
  compress: False

Editor

CKEditor

favicon.ico

In order for nginx to serve your applications favicon.ico file, it will need to be located in the following static folder within your project:

static/ico/favicon.ico
# e.g.
project/static/ico/favicon.ico

To use this icon on your site:

<link rel="shortcut icon" href="{% static 'ico/favicon.ico' %}">

Warning

We had an issue where various sites were using the KB icon. To resolve, see https://www.kbsoftware.co.uk/crm/ticket/4799/ (07/01/2021)

robots.txt

Create robots.txt in project/static/robots.txt.

Tip

Check this ticket for a very useful discussion on ‘robots.txt’

Our Nginx configuration will serve it automatically using this configuration… (no need to create URLs or templates).

Our Nginx configuration also includes a default deny-robots.txt file which is used when testing is set in the Salt pillar file.