settings.rst 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. ========
  2. Settings
  3. ========
  4. Accessing Settings
  5. ==================
  6. Misago splits its settings into two groups:
  7. * **Low level settings** - those settings must be available when Misago starts or control resources usage and shouldn't be changed frequently from admin control panel. Those settings live in ``settings.py``
  8. * **High level settings** - those settings are stored in database and can be changed on runtime using interface provided by admin control panel.
  9. Both types of settings can accessed as attributes of ``misago.conf.settings`` object and high level settings can be also accessed from your templates as attributes of ``misago_settings`` context value.
  10. .. note::
  11. Not all high level settings values are available at all times. Some settings ("lazy settings"), are evaluated to ``True`` or ``None`` immediately upon load. This means while they can be checked to see if they have value or not, but require you to use special ``get_lazy_setting(setting)`` getter to actually obtain their real value.
  12. Misago Settings Reference
  13. =========================
  14. By convention, low level settings are written in UPPER_CASE and high level ones are written in lower_case.
  15. forum_name
  16. ----------
  17. Forum name.
  18. forum_index_meta_description
  19. -----------------
  20. Forum index Meta Description used as value meta description attribute on forum index.
  21. forum_index_title
  22. -----------------
  23. Forum index title. Can be empty string if not set, in which case ``forum_name`` should be used instead.
  24. MISAGO_MAILER_BATCH_SIZE
  25. ------------------------
  26. Default maximum size of single mails package that Misago will build before sending mails and creating next package.