defaults.py 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  1. """
  2. Misago default settings
  3. This fille sets everything Misago needs to run.
  4. If you want to add custom app, middleware or path, please update setting vallue
  5. defined in this file instead of copying setting from here to your settings.py.
  6. Yes:
  7. #yourproject/settings.py
  8. INSTALLED_APPS += (
  9. 'myawesomeapp',
  10. )
  11. No:
  12. #yourproject/settings.py
  13. INSTALLED_APPS = (
  14. 'django.contrib.admin',
  15. 'django.contrib.auth',
  16. 'misago.core',
  17. 'misago.conf',
  18. ...
  19. 'myawesomeapp',
  20. )
  21. """
  22. # Build paths inside the project like this: os.path.join(MISAGO_BASE_DIR, ...)
  23. import os
  24. MISAGO_BASE_DIR = os.path.dirname(os.path.dirname(__file__))
  25. # Default JS debug to false
  26. # This setting used exclusively by test runner and isn't part of public API
  27. _MISAGO_JS_DEBUG = False
  28. # Application definition
  29. INSTALLED_APPS = (
  30. 'django.contrib.admin',
  31. # Keep misago.users above django.contrib.auth
  32. # so our management commands take precedence over theirs
  33. 'misago.users',
  34. 'django.contrib.auth',
  35. 'django.contrib.contenttypes',
  36. 'django.contrib.sessions',
  37. 'django.contrib.messages',
  38. 'django.contrib.staticfiles',
  39. 'django.contrib.humanize',
  40. 'debug_toolbar',
  41. 'crispy_forms',
  42. 'mptt',
  43. 'rest_framework',
  44. 'misago.admin',
  45. 'misago.acl',
  46. 'misago.core',
  47. 'misago.conf',
  48. 'misago.markup',
  49. 'misago.legal',
  50. 'misago.categories',
  51. 'misago.threads',
  52. 'misago.readtracker',
  53. 'misago.faker',
  54. )
  55. MIDDLEWARE_CLASSES = (
  56. 'misago.users.middleware.AvatarServerMiddleware',
  57. 'misago.users.middleware.RealIPMiddleware',
  58. 'misago.core.middleware.frontendcontext.FrontendContextMiddleware',
  59. 'django.contrib.sessions.middleware.SessionMiddleware',
  60. 'django.middleware.common.CommonMiddleware',
  61. 'django.middleware.csrf.CsrfViewMiddleware',
  62. 'django.contrib.auth.middleware.AuthenticationMiddleware',
  63. 'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
  64. 'misago.users.middleware.UserMiddleware',
  65. 'django.contrib.messages.middleware.MessageMiddleware',
  66. 'django.middleware.clickjacking.XFrameOptionsMiddleware',
  67. 'misago.core.middleware.exceptionhandler.ExceptionHandlerMiddleware',
  68. 'misago.users.middleware.OnlineTrackerMiddleware',
  69. 'misago.admin.middleware.AdminAuthMiddleware',
  70. 'misago.threads.middleware.UnreadThreadsCountMiddleware',
  71. 'misago.core.middleware.threadstore.ThreadStoreMiddleware',
  72. )
  73. TEMPLATE_CONTEXT_PROCESSORS = (
  74. 'django.contrib.auth.context_processors.auth',
  75. 'django.core.context_processors.debug',
  76. 'django.core.context_processors.i18n',
  77. 'django.core.context_processors.media',
  78. 'django.core.context_processors.static',
  79. 'django.core.context_processors.tz',
  80. 'django.contrib.messages.context_processors.messages',
  81. 'misago.core.context_processors.site_address',
  82. 'misago.conf.context_processors.settings',
  83. 'misago.users.context_processors.user_links',
  84. 'misago.legal.context_processors.legal_links',
  85. # Data preloaders
  86. 'misago.conf.context_processors.preload_settings_json',
  87. 'misago.users.context_processors.preload_user_json',
  88. # Note: keep frontend_context processor last for previous processors
  89. # to be able to add data to request.frontend_context
  90. 'misago.core.context_processors.frontend_context',
  91. )
  92. MISAGO_ACL_EXTENSIONS = (
  93. 'misago.users.permissions.account',
  94. 'misago.users.permissions.profiles',
  95. 'misago.users.permissions.warnings',
  96. 'misago.users.permissions.moderation',
  97. 'misago.users.permissions.delete',
  98. 'misago.categories.permissions',
  99. 'misago.threads.permissions.threads',
  100. 'misago.threads.permissions.privatethreads',
  101. )
  102. MISAGO_MARKUP_EXTENSIONS = ()
  103. MISAGO_POSTING_MIDDLEWARES = (
  104. # Note: always keep FloodProtectionMiddleware middleware first one
  105. 'misago.threads.posting.floodprotection.FloodProtectionMiddleware',
  106. 'misago.threads.posting.reply.ReplyFormMiddleware',
  107. 'misago.threads.posting.participants.ThreadParticipantsFormMiddleware',
  108. 'misago.threads.posting.threadlabel.ThreadLabelFormMiddleware',
  109. 'misago.threads.posting.threadpin.ThreadPinFormMiddleware',
  110. 'misago.threads.posting.threadclose.ThreadCloseFormMiddleware',
  111. 'misago.threads.posting.recordedit.RecordEditMiddleware',
  112. 'misago.threads.posting.updatestats.UpdateStatsMiddleware',
  113. # Note: always keep SaveChangesMiddleware middleware last one
  114. 'misago.threads.posting.savechanges.SaveChangesMiddleware',
  115. )
  116. MISAGO_THREAD_TYPES = (
  117. # category and redirect types
  118. 'misago.categories.categorytypes.RootCategory',
  119. 'misago.categories.categorytypes.Category',
  120. # real thread types
  121. 'misago.threads.threadtypes.thread.Thread',
  122. 'misago.threads.threadtypes.privatethread.PrivateThread',
  123. )
  124. # Register Misago directories
  125. LOCALE_PATHS = (
  126. os.path.join(MISAGO_BASE_DIR, 'locale'),
  127. )
  128. STATICFILES_DIRS = (
  129. os.path.join(MISAGO_BASE_DIR, 'static'),
  130. )
  131. TEMPLATE_DIRS = (
  132. os.path.join(MISAGO_BASE_DIR, 'templates'),
  133. )
  134. # Internationalization
  135. USE_I18N = True
  136. USE_L10N = True
  137. USE_TZ = True
  138. TIME_ZONE = 'UTC'
  139. # Misago specific date formats
  140. # https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date
  141. MISAGO_COMPACT_DATE_FORMAT_DAY_MONTH = 'j M'
  142. MISAGO_COMPACT_DATE_FORMAT_DAY_MONTH_YEAR = 'M \'y'
  143. # Use Misago CSRF Failure Page
  144. CSRF_FAILURE_VIEW = 'misago.core.errorpages.csrf_failure'
  145. # Use Misago authentication
  146. AUTH_USER_MODEL = 'misago_users.User'
  147. AUTHENTICATION_BACKENDS = (
  148. 'misago.users.authbackends.MisagoBackend',
  149. )
  150. MISAGO_NEW_REGISTRATIONS_VALIDATORS = (
  151. 'misago.users.validators.validate_gmail_email',
  152. 'misago.users.validators.validate_with_sfs',
  153. )
  154. MISAGO_STOP_FORUM_SPAM_USE = True
  155. MISAGO_STOP_FORUM_SPAM_MIN_CONFIDENCE = 80
  156. # How many e-mails should be sent in single step.
  157. # This is used for conserving memory usage when mailing many users at same time
  158. MISAGO_MAILER_BATCH_SIZE = 20
  159. # Auth paths
  160. MISAGO_LOGIN_API_URL = 'auth'
  161. LOGIN_REDIRECT_URL = 'misago:index'
  162. LOGIN_URL = 'misago:login'
  163. LOGOUT_URL = 'misago:logout'
  164. # Misago Admin Path
  165. # Omit starting and trailing slashes
  166. # To disable Misago admin, empty this value
  167. MISAGO_ADMIN_PATH = 'admincp'
  168. # Admin urls namespaces that Misago's AdminAuthMiddleware should protect
  169. MISAGO_ADMIN_NAMESPACES = (
  170. 'admin',
  171. 'misago:admin',
  172. )
  173. # How long (in minutes) since previous request to admin namespace should
  174. # admin session last.
  175. MISAGO_ADMIN_SESSION_EXPIRATION = 60
  176. # Display categories on forum index in place of threads list?
  177. MISAGO_CATEGORIES_ON_INDEX = False
  178. # Max age of notifications in days
  179. # Notifications older than this are deleted
  180. # On very active forums its better to keep this smaller
  181. MISAGO_NOTIFICATIONS_MAX_AGE = 40
  182. # Fail-safe limits in case forum is raided by spambot
  183. # No user may exceed those limits, however you may disable
  184. # them by changing them to 0
  185. MISAGO_DIALY_POST_LIMIT = 600
  186. MISAGO_HOURLY_POST_LIMIT = 100
  187. # Function used for generating individual avatar for user
  188. MISAGO_DYNAMIC_AVATAR_DRAWER = 'misago.users.avatars.dynamic.draw_default'
  189. # For which sizes avatars should be cached
  190. # Keep sizes ordered from greatest to smallest
  191. # Max size also controls min size of uploaded image as well as crop size
  192. MISAGO_AVATARS_SIZES = (400, 200, 150, 100, 64, 50, 30, 20)
  193. # Path to avatar server
  194. # This path is used to detect avatar requests, which bypass most of
  195. # Request/Response processing for performance reasons
  196. MISAGO_AVATAR_SERVER_PATH = '/user-avatar'
  197. # Number of posts displayed on single thread page
  198. MISAGO_POSTS_PER_PAGE = 15
  199. MISAGO_THREAD_TAIL = 7
  200. # Controls max age in days of items that Misago has to process to make rankings
  201. # Used for active posters and most liked users lists
  202. # If your forum runs out of memory when trying to generate users rankings list
  203. # or you want those to be more dynamic, give this setting lower value
  204. # You don't have to be overzelous with this as user rankings are cached for 24h
  205. MISAGO_RANKING_LENGTH = 30
  206. # Controls max number of items displayed on ranked lists
  207. MISAGO_RANKING_SIZE = 50
  208. # Controls number of users displayed on single page
  209. MISAGO_USERS_PER_PAGE = 12
  210. # Controls amount of data used for new threads/replies lists
  211. # Only unread threads younger than number of days specified in this setting
  212. # will be considered fresh for "new threads" list
  213. # Only unread threads with last reply younger than number of days specified
  214. # there will be confidered fresh for "Threads with unread replies" list
  215. MISAGO_FRESH_CONTENT_PERIOD = 40
  216. # X-Sendfile
  217. # X-Sendfile is feature provided by Http servers that allows web apps to
  218. # delegate serving files over to the better performing server instead of
  219. # doing it within app.
  220. # If your server supports X-Sendfile or its variation, enter header name here.
  221. # For example if you are using Nginx with X-accel enabled, set this setting
  222. # to "X-Accel-Redirect".
  223. # Leave this setting empty to Django fallback instead
  224. MISAGO_SENDFILE_HEADER = ''
  225. # Allows you to use location feature of your Http server
  226. # For example, if you have internal location /mymisago/avatar_cache/
  227. # that points at /home/myweb/misagoforum/avatar_cache/, set this setting
  228. # to "mymisago".
  229. MISAGO_SENDFILE_LOCATIONS_PATH = ''
  230. # Default forms templates
  231. CRISPY_TEMPLATE_PACK = 'bootstrap3'
  232. # Rest Framework Configuration
  233. REST_FRAMEWORK = {
  234. 'UNAUTHENTICATED_USER': 'misago.users.models.AnonymousUser',
  235. 'EXCEPTION_HANDLER': 'misago.core.exceptionhandler.handle_api_exception',
  236. 'DEFAULT_PERMISSION_CLASSES': (
  237. 'misago.users.rest_permissions.IsAuthenticatedOrReadOnly',
  238. )
  239. }
  240. # Register Misago debug panels
  241. DEBUG_TOOLBAR_PANELS = (
  242. 'debug_toolbar.panels.versions.VersionsPanel',
  243. 'debug_toolbar.panels.timer.TimerPanel',
  244. 'debug_toolbar.panels.settings.SettingsPanel',
  245. 'debug_toolbar.panels.headers.HeadersPanel',
  246. 'debug_toolbar.panels.request.RequestPanel',
  247. 'debug_toolbar.panels.sql.SQLPanel',
  248. 'misago.acl.panels.MisagoACLPanel',
  249. 'debug_toolbar.panels.staticfiles.StaticFilesPanel',
  250. 'debug_toolbar.panels.templates.TemplatesPanel',
  251. 'debug_toolbar.panels.cache.CachePanel',
  252. 'debug_toolbar.panels.signals.SignalsPanel',
  253. 'debug_toolbar.panels.logging.LoggingPanel',
  254. )