docs/source/usage/configuring.rst

   1 .. _configuring:
   2
   3 Configuring
   4 ===========
   5
   6 .. todo::
   7    Go into details on what settings do in settings.py. This should
   8    probably stick to our specifics, and provide links to Django.
   9    Probably will want to reference specific sections of docs for
  10    settings (VNC).
  11
  12 Deploying a production server requires additional setup steps.
  13
  14
  15 Required
  16 --------
  17
  18 #. Change your **SECRET\_KEY** and **WEB\_MGR\_API\_KEY** to unique (and
  19    hopefully unguessable) strings in your settings.py.
  20
  21
  22 #. Change the ownership of the ``whoosh_index`` directory to apache
  23
  24    ::
  25
  26        chown apache:apache whoosh_index/
  27
  28 #. Ensure the server has the ability to send emails or you have access
  29    to an SMTP server. Set **``EMAIL_HOST``**, **``EMAIL_PORT``**, and
  30    **``DEFAULT_FROM_EMAIL``** in settings.py. For more complicated
  31    outgoing mail setups, please refer to the `django email
  32    documentation <http://docs.djangoproject.com/en/dev/topics/email/>`_.
  33
  34 #. Configure the `Django Cache
  35    Framework <http://docs.djangoproject.com/en/dev/topics/cache/>`_ to
  36    use a production capable backend in **settings.py**. By default
  37    Ganeti Web Manager is configured to use the **LocMemCache** but it is
  38    not recommended for production. Use Memcached or a similar backend.
  39
  40    ::
  41
  42        CACHES = {
  43            'default': {
  44                'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
  45            }
  46        }
  47
  48 #. For versions >= 0.5 you may need to add the full filesystem path to
  49    your templates directory to **``TEMPLATE_DIRS``** and remove the
  50    relative reference to **``'templates'``**. We've had issues using
  51    wsgi not working correctly unless this change has been made.
  52
  53 Optional
  54 --------
  55
  56 VNC
  57 ---
  58
  59 #. Set **VNC\_PROXY** to the hostname of your VNC AuthProxy server in
  60    **settings.py**. The VNC AuthProxy does not need to run on the same
  61    server as Ganeti Web Manager.
  62
  63    ::
  64
  65        VNC_PROXY = 'my.server.org:8888'
  66
  67 SSH Keys
  68 --------