Add first round of proper documentation. Mostly taken from the README at this stage.

This commit is contained in:
Ross Poulton
2011-02-04 23:13:37 +00:00
parent d6602e96d7
commit ac37198e3f
49 changed files with 4008 additions and 173 deletions

View File

@ -0,0 +1,6 @@
django-helpdesk Ticket API
==========================
django-helpdesk includes an API accessible via HTTP POST requests, allowing you to create and alter tickets from 3rd party software and systems.
For usage instructions and command syntax, see the file templates/helpdesk/api_help.html, or visit http://helpdesk/api/help/.

View File

@ -0,0 +1,42 @@
django-helpdesk Configuration
=============================
Before django-helpdesk will be much use, you need to do some basic configuration. Most of this is done via the Django admin screens.
1. Visit ``http://yoursite/admin/`` and add a Helpdesk Queue. If you wish, enter your POP3 or IMAP server details.
**IMPORTANT NOTE**: Any tickets created via POP3 or IMAP mailboxes will DELETE the original e-mail from the mail server.
2. Visit ``http://yoursite/helpdesk/`` (or whatever path as defined in your ``urls.py``)
3. If you wish to automatically create tickets from the contents of an e-mail inbox, set up a cronjob to run the management command on a regular basis.
Don't forget to set the relevant Django environment variables in your crontab::
*/5 * * * * /path/to/helpdesksite/manage.py get_email
This will run the e-mail import every 5 minutes
**IMPORTANT NOTE**: Any tickets created via POP3 or IMAP mailboxes will DELETE the original e-mail from the mail server.
4. If you wish to automatically escalate tickets based on their age, set up a cronjob to run the escalation command on a regular basis::
0 * * * * /path/to/helpdesksite/manage.py escalate_tickets
This will run the escalation process hourly, using the 'Escalation Hours' setting for each queue to determine which tickets to escalate.
5. If you wish to exclude some days (eg, weekends) from escalation calculations, enter the dates manually via the Admin, or setup a cronjob to run a management command on a regular basis::
0 0 * * 0 /path/to/helpdesksite/manage.py create_escalation_exclusions --days saturday,sunday --escalate-verbosely
This will, on a weekly basis, create exclusions for the coming weekend.
6. Log in to your Django admin screen, and go to the 'Sites' module. If the site ``example.com`` is listed, click it and update the details so they are relevant for your website.
7. If you do not send mail directly from your web server (eg, you need to use an SMTP server) then edit your ``settings.py`` file so it contains your mail server details::
EMAIL_HOST = 'XXXXX'
EMAIL_HOST_USER = 'YYYYYY@ZZZZ.PPP'
EMAIL_HOST_PASSWORD = '123456'
You're now up and running! Happy ticketing.

View File

@ -0,0 +1,10 @@
django-helpdesk custom fields
=============================
As of February 2011, django-helpdesk supports custom fields on the ``Ticket`` model. These fields are created by using the Django administration tool, and are shown on both the public and staff submission forms.
You can use most Django field types including text, integer, boolean, and list.
The demo at http://demo.jutdahelpdesk.com contains an example of each type of custom field, including a mix of mandatory and optional fields.
Note that this feature is still in beta - it needs quite a bit of testing and no doubt has bugs!

View File

@ -0,0 +1,72 @@
Welcome to django-helpdesk's documentation!
===========================================
django-helpdesk is a Django application to manage helpdesk tickets for your internal helpdesk. It was formerly known as Jutda Helpdesk.
How Does It Look?
-----------------
You can see a demo installation at http://demo.jutdahelpdesk.com
Quick Start
-----------
django-helpdesk is just a Django application with models, views, templates, and some media. If you're comfortable with Django just try ``pip install django-helpdesk``. If not, continue to read the Installation document.
Key Features
------------
django-helpdesk has been designed for small businesses who need to recieve, manage and respond to requests for help from customers. In this context *'customers'* may be external users, or other people within your company.
* Tickets can be opened vi a email
* Multiple queues / categories of tickets
* Integrated FAQ / knowledgebase
Customer-facing Capabilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Customers (who are not 'staff' users in Django) can:
1. Browse your knowledgebase / FAQ
2. Submit support requests via web/email
3. Review open and closed requests they submitted
Staff Capabilities
~~~~~~~~~~~~~~~~~~~~
If a user is a staff member, they get general helpdesk access, including:
1. See the ticket dashboard showing unassigned tickets and basic status of the helpdesk
2. Review the tickets assigned to them
3. Search through all tickets, open and closed
4. Save their searches for future use
5. Follow up or respond to tickets
6. Assign tickets to themselves or other staff members
7. Resolve tickets
Licensing
---------
django-helpdesk is released under the BSD license, however it packages 3rd party applications which may be using a different license. See the files LICENSE and LICENSE.3RDPARTY for more details.
Dependencies
------------
1. Python 2.4+
2. Django (1.2 or newer)
3. An existing **working** Django project with database etc. If you cannot log into the Admin, you won't get this product working!
Contents:
---------
.. toctree::
:maxdepth: 2
:glob:
install
configuration
settings
spam
custom_fields
api

View File

@ -0,0 +1,78 @@
Installation
============
django-helpdesk installation isn't difficult, but it requires you have a bit of existing know-how about Django.
Getting The Code
----------------
Installing using PIP
~~~~~~~~~~~~~~~~~~~~
Try using ``pip install django-helpdesk``. Go and have a beer to celebrate Python packaging.
GIT Checkout (Cutting Edge)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
``git clone git://github.com/rossp/django-helpdesk.git``
Copy the ``helpdesk`` folder into your ``PYTHONPATH``.
I just want a .tar.gz!
~~~~~~~~~~~~~~~~~~~~~~
You can download the latest PyPi package from http://pypi.python.org/pypi/django-helpdesk/
Download, extract, and drop ``helpdesk`` into your ``PYTHONPATH``
Adding To Your Django Project
-----------------------------
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 = (
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.sites',
'django.contrib.admin', # Required for helpdesk admin/maintenance
'django.contrib.markup', # Required for text display
'helpdesk', # This is new!
)
2. Make sure django-helpdesk is accessible via ``urls.py``. Add the following line to ``urls.py``::
(r'helpdesk/', include('helpdesk.urls')),
3. Create the required database tables. I'd suggest using *South*, however the following will work::
./manage.py syncdb
4. Inside your ``MEDIA_ROOT`` folder, create a new folder called ``helpdesk`` and copy the contents of ``helpdesk/htdocs`` into it. Alternatively, create a symlink:
``ln -s /path/to/helpdesk/htdocs /path/to/media/helpdesk``
5. Inside your ``MEDIA_ROOT`` folder, inside the ``helpdesk`` folder, is a folder called ``attachments``. Ensure your web server software can write to this folder - something like this should do the trick::
chown www-data:www-data attachments/
chmod 700 attachments
(substitute www-data for the user / group that your web server runs as, eg 'apache' or 'httpd')
If all else fails ensure all users can write to it:
``chmod 777 attachments/``
This is NOT recommended, especially if you're on a shared server.
6. Ensure that your ``attachments`` folder has directory listings turned off, to ensure users don't download files that they are not specifically linked to from their tickets.
If you are using Apache, put a ``.htaccess`` file in the ``attachments`` folder with the following content:
``Options -Indexes``
You will also have to make sure that ``.htaccess`` files aren't being ignored.
Ideally, accessing http://MEDIA_URL/helpdesk/attachments/ will give you a 403 access denied error.

View File

@ -0,0 +1,20 @@
django-helpdesk settings
========================
The following settings can be changed in your ``settings.py`` file to help change the way django-helpdesk operates.
HELPDESK_DEFAULT_SETTINGS
-------------------------
django-helpdesk has a built in ``UserSettings`` entity with per-use options that they will want to configure themselves. When you create a new user, a set of options is automatically created for them which they can then change themselves.
If you want to override the default settings for your users, create ``HELPDESK_DEFAULT_SETTINGS`` as a dictionary in ``settings.py``. The default is below::
HELPDESK_DEFAULT_SETTINGS = {
'use_email_as_submitter': True,
'email_on_ticket_assign': True,
'email_on_ticket_change': True,
'login_view_ticketlist': True,
'email_on_ticket_apichange': True,
'tickets_per_page': 25
}

View File

@ -0,0 +1,31 @@
django-helpdesk spam filtering
==============================
django-helpdesk includes a copy of ``akismet.py`` by Michael Foord, which lets incoming ticket submissions be automatically checked against either the Akismet or TypePad Anti-Spam services.
To enable this functionality, sign up for an API key with one of the following services:
Akismet
~~~~~~~
* Sign up at http://akismet.com/
* Save your API key in ``settings.py`` as ``AKISMET_API_KEY``
**Note**: Akismet is only free for personal use. Paid commercial accounts are available.
TypePad AntiSpam
~~~~~~~~~~~~~~~~
* Sign up at http://antispam.typepad.com/
* Save your API key in ``settings.py`` as ``TYPEPAD_ANTISPAM_API_KEY``
This service is free to use, within their terms and conditions.
If you have either of these settings enabled, the spam filtering will be done automatically. If you have *both* settings configured, TypePad will be used instead of Akismet.
Example
~~~~~~~
A sample configuration in ``settings.py`` may be:
TYPEPAD_ANTISPAM_API_KEY = 'abc123'