configuration.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. =============
  2. Configuration
  3. =============
  4. django Organice comes with sensible defaults for almost anything. Yet still, you can customize its
  5. behavior with the help of the settings listed in this section.
  6. .. _settings:
  7. Settings
  8. ========
  9. You may define any of the following options in your project's ``settings`` to override the default
  10. value.
  11. :const:`ORGANICE_URL_PATH_ADMIN`
  12. --------------------------------
  13. :Default: ``admin``
  14. The URL path for accessing the Django Administration backend (e.g. ``www.example.com/admin``). Must
  15. be non-empty. Use an identifier only, no white space, no leading or trailing slash.
  16. :const:`ORGANICE_URL_PATH_BLOG`
  17. -------------------------------
  18. :Default: ``blog``
  19. The URL path for the blog's start page (e.g. ``www.example.com/blog``). Must be non-empty. Use an
  20. identifier only, no white space, no leading or trailing slash.
  21. :const:`ORGANICE_URL_PATH_NEWSLETTER`
  22. -------------------------------------
  23. :Default: ``newsletter``
  24. The URL path for accessing newsletter functionality on the front-end (e.g.
  25. ``www.example.com/newsletter``). Must be non-empty. Use an identifier only, no white space, no
  26. leading or trailing slash.
  27. :const:`ORGANICE_URL_PATH_TODO`
  28. -------------------------------
  29. :Default: ``todo``
  30. The URL path for accessing todo list functionality on the front-end (e.g. ``www.example.com/todo``).
  31. Must be non-empty. Use an identifier only, no white space, no leading or trailing slash.
  32. Third Party Settings
  33. ====================
  34. Analytics Providers
  35. -------------------
  36. The `analytics`:index: services supported by ``django-analytical`` are enabled by setting various
  37. service properties in your settings file. The properties are documented in `their documentation`_.
  38. For security reasons you shouldn't add those to your common settings file, but to
  39. ``settings.production``.
  40. .. _`their documentation`: https://pythonhosted.org/django-analytical/install.html#enabling-the-services