p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fixed #15983 and #16032 -- Another pass over the staticfiles docs. Many thanks to Frank Wiles and EvilDMP. 

git-svn-id: http://code.djangoproject.com/svn/django/trunk@16235 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Jannis Leidel 2011-05-18 09:51:24 +00:00
parent ee8f6ca405
commit 091c9b530e
2 changed files with 58 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
docs/howto/static-files.txt
View File

@ -34,85 +34,91 @@ single location that can easily be served in production.
Using ``django.contrib.staticfiles`` Using ``django.contrib.staticfiles``
==================================== ====================================
Here's the basic usage in a nutshell: Basic usage
-----------
1. Put your static files somewhere that ``staticfiles`` will find them. 1. Put your static files somewhere that ``staticfiles`` will find them.
By default, this means within ``static/`` subdirectories of apps in your By default, this means within ``static/`` subdirectories of apps in your
:setting:`INSTALLED_APPS`. :setting:`INSTALLED_APPS`.
Many projects will also have static assets that aren't tied to a Your project will probably also have static assets that aren't tied to a
particular app; you can give ``staticfiles`` additional directories to particular app. The :setting:`STATICFILES_DIRS` setting is a tuple of
search via the :setting:`STATICFILES_DIRS` setting . filesystem directories to check when loading static files. It's a search
path that is by default empty. See the :setting:`STATICFILES_DIRS` docs
how to extend this list of additional paths.
See the documentation for the :setting:`STATICFILES_FINDERS` setting for Additionally, see the documentation for the :setting:`STATICFILES_FINDERS`
details on how ``staticfiles`` finds your files. setting for details on how ``staticfiles`` finds your files.
2. Set the :setting:`STATIC_URL` setting to the URL you want to use 2. Make sure that ``django.contrib.staticfiles`` is included in your
for pointing to your static files, e.g.:: :setting:`INSTALLED_APPS`.
STATIC_URL = '/static/' For :ref:`local development<staticfiles-development>`, if you are using
:ref:`runserver<staticfiles-runserver>` or adding
:ref:`staticfiles_urlpatterns<staticfiles-development>` to your
URLconf, you're done with the setup -- your static files will
automatically be served at the default (for
:djadmin:`newly created<startproject>` projects) :setting:`STATIC_URL`
of ``/static/``.
In projects freshly created with the :djadmin:`startproject` 3. You'll probably need to refer to these files in your templates. The
management command this will be preset to ``'/static/'``. easiest method is to use the included context processor which allows
template code like:
3. Make sure that ``django.contrib.staticfiles`` is in your .. code-block:: html+django
:setting:`INSTALLED_APPS`.
For :ref:`local development<staticfiles-development>`, if you are using <img src="{{ STATIC_URL }}images/hi.jpg />
:ref:`runserver<staticfiles-runserver>` or adding
:ref:`staticfiles_urlpatterns<staticfiles-development>` to your URLconf,
you're done! Your static files will automatically be served at the
:setting:`STATIC_URL` you specified in step 2.
4. You'll probably need to refer to these files in your templates. The See :ref:`staticfiles-in-templates` for more details, including an
easiest method is to use the included context processor which will allow alternate method using a template tag.
template code like:
.. code-block:: html+django Deploying static files in a nutshell
------------------------------------
<img src="{{ STATIC_URL }}images/hi.jpg />
See :ref:`staticfiles-in-templates` for more details, including an
alternate method (using a template tag).
When you're ready to move out of local development and deploy your project: When you're ready to move out of local development and deploy your project:
1. Set the :setting:`STATIC_ROOT` setting to point to where you'd like your 1. Set the :setting:`STATIC_URL` setting to the public URL for your static
static files collected to when you use the :djadmin:`collectstatic` files (in most cases, the default value of ``/static/`` is just fine).
management command. For example::
STATIC_ROOT = "/home/jacob/projects/mysite.com/sitestatic" 2. Set the :setting:`STATIC_ROOT` setting to point to the filesystem path
you'd like your static files collected to when you use the
:djadmin:`collectstatic` management command. For example::
2. Run the :djadmin:`collectstatic` management command:: STATIC_ROOT = "/home/jacob/projects/mysite.com/sitestatic"
./manage.py collectstatic 3. Run the :djadmin:`collectstatic` management command::
This'll churn through your static file storage and copy them into the ./manage.py collectstatic
directory given by :setting:`STATIC_ROOT`.
3. Deploy those files by configuring your webserver of choice to serve the This'll churn through your static file storage and copy them into the
files in :setting:`STATIC_ROOT` at :setting:`STATIC_URL`. directory given by :setting:`STATIC_ROOT`.
:ref:`staticfiles-production` covers some common deployment strategies 4. Deploy those files by configuring your webserver of choice to serve the
for static files. files in :setting:`STATIC_ROOT` at :setting:`STATIC_URL`.
Those are the basics. For more details on common configuration options, read on; :ref:`staticfiles-production` covers some common deployment strategies
for a detailed reference of the settings, commands, and other bits included with for static files.
the framework see :doc:`the staticfiles reference </ref/contrib/staticfiles>`.
Those are the **basics**. For more details on common configuration options,
read on; for a detailed reference of the settings, commands, and other bits
included with the framework see
:doc:`the staticfiles reference </ref/contrib/staticfiles>`.
.. note:: .. note::
In previous versions of Django, it was common to place static assets in In previous versions of Django, it was common to place static assets in
:setting:`MEDIA_ROOT` along with user-uploaded files, and serve them both at :setting:`MEDIA_ROOT` along with user-uploaded files, and serve them both
:setting:`MEDIA_URL`. Part of the purpose of introducing the ``staticfiles`` at :setting:`MEDIA_URL`. Part of the purpose of introducing the
app is to make it easier to keep static files separate from user-uploaded ``staticfiles`` app is to make it easier to keep static files separate
files. For this reason, you need to make your :setting:`MEDIA_ROOT` and from user-uploaded files.
For this reason, you need to make your :setting:`MEDIA_ROOT` and
:setting:`MEDIA_URL` different from your :setting:`STATIC_ROOT` and :setting:`MEDIA_URL` different from your :setting:`STATIC_ROOT` and
:setting:`STATIC_URL`. You will need to arrange for serving of files in :setting:`STATIC_URL`. You will need to arrange for serving of files in
:setting:`MEDIA_ROOT` yourself; ``staticfiles`` does not deal with :setting:`MEDIA_ROOT` yourself; ``staticfiles`` does not deal with
user-uploaded files at all. You can, however, use user-uploaded files at all. You can, however, use
:func:`~django.views.static.serve` view for serving :setting:`MEDIA_ROOT` :func:`django.views.static.serve` view for serving :setting:`MEDIA_ROOT`
in development; see :ref:`staticfiles-other-directories`. in development; see :ref:`staticfiles-other-directories`.
.. _staticfiles-in-templates: .. _staticfiles-in-templates:
@ -303,7 +309,7 @@ development::
.. note:: .. note::
The helper function will only be operational in debug mode and if This helper function will only be operational in debug mode and if
the given prefix is local (e.g. ``/static/``) and not a URL (e.g. the given prefix is local (e.g. ``/static/``) and not a URL (e.g.
``http://static.example.com/``). ``http://static.example.com/``).

2
docs/ref/contrib/staticfiles.txt
View File

@ -296,7 +296,7 @@ primary URL configuration::
url(r'^static/(?P<path>.*)$', 'serve'), url(r'^static/(?P<path>.*)$', 'serve'),
) )
Note, the begin of the pattern (``r'^static/'``) should be your Note, the beginning of the pattern (``r'^static/'``) should be your
:setting:`STATIC_URL` setting. :setting:`STATIC_URL` setting.
Since this is a bit finicky, there's also a helper function that'll do this for you: Since this is a bit finicky, there's also a helper function that'll do this for you: