Configuration
*************

A configuration example is provided in `pytition/settings/config_example.py`.
You should copy and edit it to configure Pytition.


Mandatory settings
==================

You **must** set the following variables:

.. automodule:: pytition.settings.config_example
  :members:

Not mandatory but important settings
====================================

You are **highly encouraged** to set the following variables in a production environment:

Pytition specific settings
--------------------------

.. autodata:: pytition.settings.base.USE_MAIL_QUEUE
.. autodata:: pytition.settings.base.ALLOW_REGISTER
.. autodata:: pytition.settings.base.DEFAULT_NOREPLY_MAIL

Django settings
---------------

The following settings are important to set so that the email sent by Pytition are less likely to be considered as spam/junk.
You should configure a real SMTP email account and not just rely on "fake" email address from local sendmail:

.. hlist::

  * :setting:`DEFAULT_FROM_EMAIL`
  * :setting:`SERVER_EMAIL`
  * :setting:`EMAIL_HOST`
  * :setting:`EMAIL_HOST_PASSWORD`
  * :setting:`EMAIL_HOST_USER`
  * :setting:`EMAIL_PORT`
  * :setting:`EMAIL_USE_TLS`
  * :setting:`EMAIL_USE_SSL`
  * others when necessary

Other optional settings
=======================

Those are things you can configure to customize your Pytition instance:

.. autodata:: pytition.settings.base.SITE_NAME
.. autodata:: pytition.settings.base.FOOTER_TEMPLATE
.. autodata:: pytition.settings.base.DISABLE_USER_PETITION
.. autodata:: pytition.settings.base.RESTRICT_ORG_CREATION