Update docs to add SITE_ID, to address #481

This commit is contained in:
Garret Wassermann 2017-02-10 16:17:16 -05:00
parent 7c5daa26ea
commit 3740cd5ddc

View File

@ -35,7 +35,7 @@ Adding To Your Django Project
'django.contrib.auth', 'django.contrib.auth',
'django.contrib.contenttypes', 'django.contrib.contenttypes',
'django.contrib.sessions', 'django.contrib.sessions',
'django.contrib.sites', # Required for determing domain url for use in emails 'django.contrib.sites', # Required for determining domain url for use in emails
'django.contrib.admin', # Required for helpdesk admin/maintenance 'django.contrib.admin', # Required for helpdesk admin/maintenance
'django.contrib.humanize', # Required for elapsed time formatting 'django.contrib.humanize', # Required for elapsed time formatting
'markdown_deux', # Required for Knowledgebase item formatting 'markdown_deux', # Required for Knowledgebase item formatting
@ -43,6 +43,12 @@ Adding To Your Django Project
'helpdesk', # This is us! 'helpdesk', # This is us!
) )
Your ``settings.py`` file should also define a ``SITE_ID`` that allows multiple projects to share
a single database, and is required by ``django.contrib.sites`` in Django 1.9+.
If you aren't running multiple sites, you can simply add a default ``SITE_ID`` to ``settings.py``::
SITE_ID = 1
2. Make sure django-helpdesk is accessible via ``urls.py``. Add the following line to ``urls.py``:: 2. Make sure django-helpdesk is accessible via ``urls.py``. Add the following line to ``urls.py``::
url(r'helpdesk/', include('helpdesk.urls')), url(r'helpdesk/', include('helpdesk.urls')),