mirror of
https://github.com/django-helpdesk/django-helpdesk.git
synced 2025-08-09 08:05:13 +02:00
Rework README and CONTRIBUTING to remove redundancy. Some README statements moved to install docs instead.
This commit is contained in:
@ -29,6 +29,10 @@ Download, extract, and drop ``helpdesk`` into your ``PYTHONPATH``
|
||||
Adding To Your Django Project
|
||||
-----------------------------
|
||||
|
||||
If you're on a brand new Django installation, make sure you do a ``migrate``
|
||||
**before** adding ``helpdesk`` to your ``INSTALLED_APPS``. This will avoid
|
||||
errors with trying to create User settings.
|
||||
|
||||
1. Edit your ``settings.py`` file and add ``helpdesk`` to the ``INSTALLED_APPS`` setting. You also need ``django.contrib.admin`` in ``INSTALLED_APPS`` if you haven't already added it. eg::
|
||||
|
||||
INSTALLED_APPS = (
|
||||
@ -115,3 +119,46 @@ Adding To Your Django Project
|
||||
|
||||
Also, be aware that if a disk error occurs and the local file is not deleted, the mail may be processed multiple times and generate duplicate tickets until the file is removed. It is recommended to monitor log files for ERRORS when a file is unable to be deleted.
|
||||
|
||||
Upgrading from previous versions
|
||||
--------------------------------
|
||||
|
||||
If you are upgrading from a previous version of django-helpdesk that used
|
||||
migrations, get an up to date version of the code base (eg by using
|
||||
`git pull` or `pip install --upgrade django-helpdesk`) then migrate the database::
|
||||
|
||||
python manage.py migrate helpdesk --db-dry-run # DB untouched
|
||||
python manage.py migrate helpdesk
|
||||
|
||||
Lastly, restart your web server software (eg Apache) or FastCGI instance, to
|
||||
ensure the latest changes are in use.
|
||||
|
||||
Unfortunately we are unable to assist if you are upgrading from a
|
||||
version of django-helpdesk prior to migrations (ie pre-2011).
|
||||
|
||||
You can continue to the 'Initial Configuration' area, if needed.
|
||||
|
||||
Notes on database backends
|
||||
--------------------------
|
||||
|
||||
**NOTE REGARDING SQLITE AND SEARCHING:**
|
||||
If you use sqlite as your database, the search function will not work as
|
||||
effectively as it will with other databases due to its inability to do
|
||||
case-insensitive searches. It's recommended that you use PostgreSQL or MySQL
|
||||
if possible. For more information, see this note in the Django documentation:
|
||||
http://docs.djangoproject.com/en/dev/ref/databases/#sqlite-string-matching
|
||||
|
||||
When you try to do a keyword search using sqlite, a message will be displayed
|
||||
to alert you to this shortcoming. There is no way around it, sorry.
|
||||
|
||||
**NOTE REGARDING MySQL:**
|
||||
If you use MySQL, with most default configurations you will receive an error
|
||||
when creating the database tables as we populate a number of default templates
|
||||
in languages other than English.
|
||||
|
||||
You must create the database the holds the django-helpdesk tables using the
|
||||
UTF-8 collation; see the MySQL manual for more information:
|
||||
http://dev.mysql.com/doc/refman/5.1/en/charset-database.html
|
||||
|
||||
If you do NOT do this step, and you only want to use English-language templates,
|
||||
you can continue however you will receive a warning when running the 'migrate'
|
||||
commands.
|
||||
|
@ -1,15 +1,7 @@
|
||||
Settings
|
||||
========
|
||||
|
||||
First, django-helpdesk needs ``django.core.context_processors.request`` activated, so you must add it to the ``settings.py``. For Django 1.7, add::
|
||||
|
||||
from django.conf import global_settings
|
||||
TEMPLATE_CONTEXT_PROCESSORS = (
|
||||
global_settings.TEMPLATE_CONTEXT_PROCESSORS +
|
||||
('django.core.context_processors.request',)
|
||||
)
|
||||
|
||||
For Django 1.8 and onwards, the settings are located in the ``TEMPLATES``, and the ``request`` module has moved. Add the following instead::
|
||||
First, django-helpdesk needs ``django.core.context_processors.request`` activated, so you must add it to the ``settings.py``. Add the following::
|
||||
|
||||
TEMPLATES = [
|
||||
{
|
||||
@ -75,11 +67,11 @@ These changes are visible throughout django-helpdesk
|
||||
**Default:** ``HELPDESK_SHOW_CHANGE_PASSWORD = False``
|
||||
|
||||
- **HELPDESK_FOLLOWUP_MOD** Allow user to override default layout for 'followups' (work in progress)
|
||||
|
||||
|
||||
**Default:** ``HELPDESK_FOLLOWUP_MOD = False``
|
||||
|
||||
- **HELPDESK_AUTO_SUBSCRIBE_ON_TICKET_RESPONSE** Auto-subscribe user to ticket as a 'CC' if (s)he responds to a ticket?
|
||||
|
||||
|
||||
**Default:** ``HELPDESK_AUTO_SUBSCRIBE_ON_TICKET_RESPONSE = False``
|
||||
|
||||
- **HELPDESK_EMAIL_SUBJECT_TEMPLATE** Subject template for templated emails. ``%(subject)s`` represents the subject wording from the email template (e.g. "(Closed)").
|
||||
@ -97,24 +89,24 @@ Options shown on public pages
|
||||
These options only change display of items on public-facing pages, not staff pages.
|
||||
|
||||
- **HELPDESK_VIEW_A_TICKET_PUBLIC** Show 'View a Ticket' section on public page?
|
||||
|
||||
|
||||
**Default:** ``HELPDESK_VIEW_A_TICKET_PUBLIC = True``
|
||||
|
||||
- **HELPDESK_SUBMIT_A_TICKET_PUBLIC** Show 'submit a ticket' section & form on public page?
|
||||
|
||||
|
||||
**Default:** ``HELPDESK_SUBMIT_A_TICKET_PUBLIC = True``
|
||||
|
||||
|
||||
Options that change ticket updates
|
||||
----------------------------------
|
||||
|
||||
- **HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE** Allow non-staff users to interact with tickets? This will also change how 'staff_member_required'
|
||||
- **HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE** Allow non-staff users to interact with tickets? This will also change how 'staff_member_required'
|
||||
in staff.py will be defined.
|
||||
|
||||
|
||||
**Default:** ``HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = False``
|
||||
|
||||
- **HELPDESK_SHOW_EDIT_BUTTON_FOLLOW_UP** Show edit buttons in ticket follow ups?
|
||||
|
||||
|
||||
**Default:** ``HELPDESK_SHOW_EDIT_BUTTON_FOLLOW_UP = True``
|
||||
|
||||
- **HELPDESK_SHOW_DELETE_BUTTON_SUPERUSER_FOLLOW_UP** Show delete buttons in ticket follow ups if user is 'superuser'?
|
||||
@ -167,7 +159,7 @@ Discontinued Settings
|
||||
|
||||
The following settings were defined in previous versions and are no longer supported.
|
||||
|
||||
- **HELPDESK_CUSTOM_WELCOME**
|
||||
- **HELPDESK_CUSTOM_WELCOME**
|
||||
|
||||
- **HELDPESK_KB_ENABLED_STAFF** Now always True
|
||||
|
||||
|
Reference in New Issue
Block a user