extern/django-helpdesk
1
0
Fork 1
mirror of https://github.com/django-helpdesk/django-helpdesk.git synced 2025-08-19 04:06:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rebuilt HTML documentation

Browse Source
This commit is contained in:
Ross Poulton
2011-02-05 05:11:34 +00:00
parent a15c8e0e23
commit 613b2fc132
26 changed files with 476 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/html/_sources/api.txt
View File

@@ -1,6 +1,6 @@
django-helpdesk Ticket API
==========================
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/.
For usage instructions and command syntax, see the file ``templates/helpdesk/api_help.html``, or visit http://helpdesk/api/help/.

4
docs/html/_sources/configuration.txt
View File

@@ -1,5 +1,5 @@
django-helpdesk Configuration
=============================
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.

4
docs/html/_sources/custom_fields.txt
View File

@@ -1,5 +1,5 @@
django-helpdesk custom fields
=============================
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.

3
docs/html/_sources/index.txt
View File

@@ -47,7 +47,7 @@ If a user is a staff member, they get general helpdesk access, including:
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.
django-helpdesk is released under the BSD license, however it packages 3rd party applications which may be using a different license. More details can be found in the :doc:`license documentation`.
Dependencies
------------
@@ -63,6 +63,7 @@ Contents:
:maxdepth: 2
:glob:
license
install
configuration
settings

26
docs/html/_sources/install.txt
View File

@@ -15,7 +15,7 @@ Try using ``pip install django-helpdesk``. Go and have a beer to celebrate Pytho
GIT Checkout (Cutting Edge)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
``git clone git://github.com/rossp/django-helpdesk.git``
If you're planning on editing the code or just want to get whatever is the latest and greatest, you can clone the official Git repository with ``git clone git://github.com/rossp/django-helpdesk.git``
Copy the ``helpdesk`` folder into your ``PYTHONPATH``.
@@ -49,30 +49,30 @@ Adding To Your Django Project
./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:
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``
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
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')
(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:
If all else fails ensure all users can write to it::
``chmod 777 attachments/``
chmod 777 attachments/
This is NOT recommended, especially if you're on a shared server.
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:
If you are using Apache, put a ``.htaccess`` file in the ``attachments`` folder with the following content::
``Options -Indexes``
Options -Indexes
You will also have to make sure that ``.htaccess`` files aren't being ignored.
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.
Ideally, accessing http://MEDIA_URL/helpdesk/attachments/ will give you a 403 access denied error.

110
docs/html/_sources/license.txt Normal file
View File

@@ -0,0 +1,110 @@
License
=======
django-helpdesk is released under the terms of the BSD license. You must agree to these terms before installing or using django-helpdesk.::
Copyright (c) 2008, Ross Poulton (Trading as Jutda)
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of Ross Poulton, Jutda, nor the names of any
of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
EXCEPTIONS
This software is distributed with some third-party software which is not distributed under the above license. See LICENSE.3RDPARTY for further details.
django-helpdesk includes 3rd party software. The licenses for these
applications are included below.
License for jQuery & jQuery UI
------------------------------
::
Copyright (c) 2007 John Resig, http://jquery.com/
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License for jQuery UI 'Smoothness' theme
----------------------------------------
::
/*
* jQuery UI screen structure and presentation
* This CSS file was generated by ThemeRoller, a Filament Group Project for jQuery UI
* Author: Scott Jehl, scott@filamentgroup.com, http://www.filamentgroup.com
* Visit ThemeRoller.com
*/
License for akismet.py
----------------------
::
Copyright (c) 2003-2009, Michael Foord
All rights reserved.
E-mail : fuzzyman AT voidspace DOT org DOT uk
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of Michael Foord nor the name of Voidspace
may be used to endorse or promote products derived from this
software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

4
docs/html/_sources/settings.txt
View File

@@ -1,5 +1,5 @@
django-helpdesk settings
========================
Settings
========
The following settings can be changed in your ``settings.py`` file to help change the way django-helpdesk operates.

13
docs/html/_sources/spam.txt
View File

@@ -1,9 +1,9 @@
django-helpdesk spam filtering
==============================
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.
django-helpdesk includes a copy of ``akismet.py`` by `Michael Foord <http://www.voidspace.org.uk/>`_, which lets incoming ticket submissions be automatically checked against either the `Akismet <http://akismet.com/>`_ or `TypePad Anti-Spam <http://antispam.typepad.com/>`_ services.
To enable this functionality, sign up for an API key with one of the following services:
To enable this functionality, sign up for an API key with one of these two services.
Akismet
~~~~~~~
@@ -26,6 +26,7 @@ If you have either of these settings enabled, the spam filtering will be done au
Example
~~~~~~~
A sample configuration in ``settings.py`` may be:
A sample configuration in ``settings.py`` may be::
TYPEPAD_ANTISPAM_API_KEY = 'abc123'
TYPEPAD_ANTISPAM_API_KEY = 'abc123'