weblate/docs/config.rst
2012-08-01 14:22:33 +02:00

139 lines
2.9 KiB
ReStructuredText
Vendored

.. _config:
Configuration
=============
All settings are stored in :file:`settings.py` (as usual for Django).
.. note::
After changing any of these settings, you need to restart Weblate. In case
it is run as mod_wsgi, you need to restart Apache to reload the
configuration.
.. seealso::
Please check also `Django's documentation`_ for parameters which configure
Django itself.
.. _`Django's documentation`: https://docs.djangoproject.com/en/1.4/ref/settings/
.. setting:: AUTO_LOCK
AUTO_LOCK
---------
Enables automatic locking of translation when somebody is working on it.
.. seealso:: :ref:`locking`
.. setting:: LOCK_TIME
LOCK_TIME
---------
Time in seconds for how long the translation will be locked for single
translator.
.. seealso:: :ref:`locking`
.. setting:: CHECK_LIST
CHECK_LIST
----------
List of consistency checks to perform on translation.
.. seealso:: :ref:`checks`, :ref:`custom-checks`
.. setting:: ENABLE_HOOKS
ENABLE_HOOKS
------------
Whether to enable anonymous remote hooks.
.. seealso:: :ref:`hooks`
.. setting:: GIT_ROOT
GIT_ROOT
--------
Path where Weblate will store cloned Git repositories. Defaults to
:file:`repos` subdirectory.
.. setting:: LAZY_COMMITS
LAZY_COMMITS
------------
Delay creating Git commits until this is necessary. This heavily reduces
number of commits generated by Weblate at expense of temporarily not being
able to merge some changes as they are not yet committed.
.. seealso:: :ref:`lazy-commit`
.. setting:: MT_APERTIUM_KEY
MT_APERTIUM_KEY
---------------
API key for Apertium Web Service, you can register at http://api.apertium.org/register.jsp
.. seealso:: :ref:`machine-translation`
.. setting:: MT_MICROSOFT_KEY
MT_MICROSOFT_KEY
----------------
API key for Microsoft Translator service, you can register at http://www.bing.com/developers/createapp.aspx
.. seealso:: :ref:`machine-translation`
.. setting:: NEARBY_MESSAGES
NEARBY_MESSAGES
---------------
How many messages around current one to show during translating.
.. setting:: OFFLOAD_INDEXING
OFFLOAD_INDEXING
----------------
Offload updating of fulltext index to separate process. This heavily
improves responsiveness of online operation on expense of slightly
outdated index, which might still point to older content.
While enabling this, don't forget scheduling runs of
:djadmin:`update_index` in cron or similar tool.
This is recommended setup for production use.
.. seealso:: :ref:`fulltext`
.. setting:: SIMILAR_MESSAGES
SIMILAR_MESSAGES
----------------
Number of similar messages to lookup. This is not a hard limit, just a
number Weblate tries to find if it is possible.
.. setting:: SITE_TITLE
SITE_TITLE
----------
Site title to be used in website and emails as well.
.. setting:: WHOOSH_INDEX
WHOOSH_INDEX
------------
Directory where Whoosh fulltext indices will be stored. Defaults to :file:`whoosh-index` subdirectory.