py_tasks_melange: thirdparty/google_appengine/lib/django/docs/static

109 620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	1	=========================
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	2	How to serve static files
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	3	=========================
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	4
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	5	Django itself doesn't serve static (media) files, such as images, style sheets,
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	6	or video. It leaves that job to whichever Web server you choose.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	7
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	8	The reasoning here is that standard Web servers, such as Apache_ and lighttpd_,
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	9	are much more fine-tuned at serving static files than a Web application
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	10	framework.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	11
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	12	With that said, Django does support static files during development. Use
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	13	the view ``django.views.static.serve`` to serve media files.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	14
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	15	.. _Apache: http://httpd.apache.org/
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	16	.. _lighttpd: http://www.lighttpd.net/
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	17
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	18	The big, fat disclaimer
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	19	=======================
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	20
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	21	Using this method is inefficient and insecure. Do not use this in a
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	22	production setting. Use this only for development.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	23
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	24	For information on serving static files in an Apache production environment,
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	25	see the `Django mod_python documentation`_.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	26
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	27	.. _Django mod_python documentation: ../modpython/#serving-media-files
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	28
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	29	How to do it
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	30	============
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	31
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	32	Just put this in your URLconf_::
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	33
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	34	(r'^site_media/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/path/to/media'}),
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	35
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	36	...where ``site_media`` is the URL where your media will be rooted, and
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	37	``/path/to/media`` is the filesystem root for your media.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	38
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	39	You must pass a ``document_root`` parameter to indicate the filesystem root.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	40
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	41	Examples:
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	42
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	43	* The file ``/path/to/media/foo.jpg`` will be made available at the URL
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	44	``/site_media/foo.jpg``.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	45
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	46	* The file ``/path/to/media/css/mystyles.css`` will be made available
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	47	at the URL ``/site_media/css/mystyles.css``.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	48
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	49	* The file ``/path/bar.jpg`` will not be accessible, because it doesn't
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	50	fall under the document root.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	51
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	52	.. _URLconf: ../url_dispatch/
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	53
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	54	Directory listings
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	55	==================
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	56
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	57	Optionally, you can pass a ``show_indexes`` parameter to the ``static.serve``
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	58	view. This is ``False`` by default. If it's ``True``, Django will display file
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	59	listings for directories.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	60
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	61	Example::
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	62
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	63	(r'^site_media/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/path/to/media', 'show_indexes': True}),
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	64
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	65	You can customize the index view by creating a template called
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	66	``static/directory_index``. That template gets two objects in its context:
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	67
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	68	* ``directory`` -- the directory name (a string)
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	69	* ``file_list`` -- a list of file names (as strings) in the directory
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	70
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	71	Here's the default ``static/directory_index`` template::
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	72
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	73	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	74	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	75	<head>
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	76	<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	77	<meta http-equiv="Content-Language" content="en-us" />
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	78	<meta name="robots" content="NONE,NOARCHIVE" />
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	79	<title>Index of {{ directory }}</title>
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	80	</head>
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	81	<body>
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	82	<h1>Index of {{ directory }}</h1>
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	83	<ul>
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	84	{% for f in file_list %}
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	85	<li><a href="{{ f }}">{{ f }}</a></li>
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	86	{% endfor %}
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	87	</ul>
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	88	</body>
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	89	</html>
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	90
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	91	Limiting use to DEBUG=True
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	92	==========================
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	93
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	94	Because URLconfs are just plain Python modules, you can use Python logic to
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	95	make the static-media view available only in development mode. This is a handy
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	96	trick to make sure the static-serving view doesn't slip into a production
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	97	setting by mistake.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	98
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	99	Do this by wrapping an ``if DEBUG`` statement around the
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	100	``django.views.static.serve`` inclusion. Here's a full example URLconf::
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	101
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	102	from django.conf.urls.defaults import *
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	103	from django.conf import settings
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	104
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	105	urlpatterns = patterns('',
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	106	(r'^/articles/2003/$', 'news.views.special_case_2003'),
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	107	(r'^/articles/(?P<year>\d{4})/$', 'news.views.year_archive'),
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	108	(r'^/articles/(?P<year>\d{4})/(?P<month>\d{2})/$', 'news.views.month_archive'),
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	109	(r'^/articles/(?P<year>\d{4})/(?P<month>\d{2})/(?P<day>\d+)/$', 'news.views.article_detail'),
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	110	)
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	111
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	112	if settings.DEBUG:
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	113	urlpatterns += patterns('',
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	114	(r'^site_media/(?P<path>.*)$', 'django.views.static.serve', {'document_root': '/path/to/media'}),
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	115	)
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	116
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	117	This code is straightforward. It imports the settings and checks the value of
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	118	the ``DEBUG`` setting. If it evaluates to ``True``, then ``site_media`` will be
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	119	associated with the ``django.views.static.serve`` view. If not
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	120	(``DEBUG == False``), then the view won't be made available.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	121
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	122	Of course, the catch here is that you'll have to remember to set ``DEBUG=False``
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	123	in your production settings file. But you should be doing that anyway.
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	124
620f9b141567 Load ../../google_appengine into trunk/thirdparty/google_appengine. Todd Larsen <tlarsen@google.com> parents: diff changeset	125	.. _DEBUG setting: ../settings/#debug

author	Sverre Rabbelier <srabbelier@gmail.com>
	Wed, 11 Feb 2009 23:42:03 +0000
changeset 1267	157c12589f79
parent 109	620f9b141567
permissions	-rw-r--r--