production.rst is really redundant right now.

This commit is contained in:
James Socol 2011-01-19 12:46:23 -05:00
Родитель e4e6f65469
Коммит 1d9bb3f592
1 изменённых файлов: 0 добавлений и 133 удалений

Просмотреть файл

@ -1,133 +0,0 @@
================================
Extra Information for Production
================================
There are a few small steps we need to take for production:
Environment
-----------
Requirements
^^^^^^^^^^^^
The full list of requirements is:
* Python 2.6
* `setuptools <http://pypi.python.org/pypi/setuptools#downloads>`_
* MySQL headers (for the Python-MySQL connector).
* `virtualenv <http://pypi.python.org/pypi/virtualenv>`_
* `mod_wsgi <http://code.google.com/p/modwsgi>`_
* Apache HTTPD Server
* RabbitMQ
* libjpeg or a similar library for JPEG support that works with
`PIL <http://www.pythonware.com/products/pil/>`
* The Python packages in the ``requirements.txt`` file.
Settings
^^^^^^^^
Settings in ``settings.py`` can be overridden in a file named
``settings_local.py`` in the same directory. ``settings_local.py`` should
start with::
from settings import *
and below that line, you can override the defaults.
The following settings may need to be set:
``DEBUG`` and ``TEMPLATE_DEBUG``
Set both of these to ``False`` for production environments.
``DATABASES``
Tells Django what databases to talk to. The ``ENGINE`` should probably
be ``django.db.backends.mysql``. Set the database named ``default`` to
the master, and you can add additional databases to the ``DATABASES``
dict to use as slaves. (See ``SLAVE_DATABASES`` below.)
``SLAVE_DATABASES``
If you've added additional databases to the ``DATABASES`` dict above,
you should specify which ones are slaves by putting their names in
the ``SLAVE_DATABASES`` list. (Eg:
``SLAVE_DATABASES = ['slave-1', 'slave-2']``)
``CACHE_BACKEND``
Set to ``caching.backends.memcached://host-1:port;host-2:port``.
``CACHE_PREFIX``
Something to differentiate from other data on the same memcache instance.
We recommend ``CACHE_PREFIX = 'sumo:'`` if anything.
``SECRET_KEY``
Set this to something long, random, and secret.
``SPHINX_HOST``
Point to the Sphinx host.
``SPHINX_PORT``
Much like ``SPHINX_HOST``.
``SPHINX_INDEXER``, ``SPHINX_SEARCHD``, and ``SPHINX_CONFIG_PATH``
These only need to be set for running tests. You can ignore them.
``JAVA_BIN``
If the system java binary is not at ``/usr/bin/java``, you should set
this. (It's only used for running the ``compress_assets`` command. See
below.)
``CELERY_ALWAYS_EAGER``
This should be set to ``False`` to actually use Rabbit/Celery.
``BROKER_*``
These should be set to allow Kitsune to talk to your RabbitMQ server.
``WEBTRENDS_WIKI_REPORT_URL``
The URL from which JSON-formatted WebTrends reports about the Knowledge Base
can be downloaded, e.g.
https://foo.com/v2_1/ReportService/profiles/12345/reports/98765/?format=json.
Leave out the start_period and end_period parameters.
``WEBTRENDS_USER``
The WebTrends user with which to authenticate to the above URL. Format:
account\username
``WEBTRENDS_PASSWORD``
The password with which to authenticate to WebTrends
Concat and Minify
-----------------
When running with ``DEBUG=False``, Kitsune will try to use compressed
JavaScript and CSS. To generate the compressed files, just run::
./manage.py compress_assests
and new files will be created in the /media/ directory.
Uploads
-----------------
Uploaded files must be served from anywhere under the media folder. The full
path to this folder can be changed in the setting ``MEDIA_ROOT``.
Here are the currently defined upload settings. All paths are relative to
``MEDIA_ROOT``::
``THUMBNAIL_UPLOAD_PATH``
Thumbnails of images for questions. defaults to
``uploads/images/thumbnails/``.
``IMAGE_UPLOAD_PATH``
Images for questions, defaults to ``uploads/images/``.
``GALLERY_VIDEO_URL``
Prefix for video URLs, which can point to the CDN. E.g.
``http://videos.mozilla.org/serv/sumo/``
``GALLERY_IMAGE_THUMBNAIL_PATH``, ``GALLERY_VIDEO_THUMBNAIL_PATH``
Thumbnails of video/images for the media gallery, defaults to
``uploads/gallery/thumbnails/``.
``GALLERY_IMAGE_PATH``, ``GALLERY_VIDEO_PATH``
Video/images for the media gallery, defaults to ``uploads/gallery/``.
``IMAGE_MAX_FILESIZE``, ``VIDEO_MAX_FILESIZE``
Maximum size for uploaded images (defaults to 1mb) or videos (16mb).
``THUMBNAIL_PROGRESS_URL``
URL to an image, used to indicate thumbnail generation is in progress.
``WIKI_VIDEO_HEIGHT``, ``WIKI_VIDEO_WIDTH``
Height and width set on the video tag for videos included in Knowledge
Base documents.