2015-12-16 00:35:00 +01:00
|
|
|
django-helpdesk - A Django powered ticket tracker for small businesses.
|
2011-02-05 05:51:34 +01:00
|
|
|
=======================================================================
|
2008-02-06 05:36:07 +01:00
|
|
|
|
2021-10-19 04:31:43 +02:00
|
|
|
[](https://dev.azure.com/django-helpdesk/django-helpdesk/_build/latest?definitionId=1&branchName=master)
|
2013-11-12 05:28:28 +01:00
|
|
|
|
2018-09-02 05:29:28 +02:00
|
|
|
.. image:: https://codecov.io/gh/django-helpdesk/django-helpdesk/branch/develop/graph/badge.svg
|
2016-10-20 13:08:34 +02:00
|
|
|
:target: https://codecov.io/gh/django-helpdesk/django-helpdesk
|
|
|
|
|
|
2021-08-20 08:12:55 +02:00
|
|
|
Copyright 2009-2021 Ross Poulton and django-helpdesk contributors. All Rights Reserved.
|
2017-03-20 08:19:53 +01:00
|
|
|
See LICENSE for details.
|
2008-01-07 21:22:13 +01:00
|
|
|
|
2016-10-22 00:57:14 +02:00
|
|
|
django-helpdesk was formerly known as Jutda Helpdesk, named after the
|
2016-10-27 09:26:07 +02:00
|
|
|
company which originally created it. As of January 2011 the name has been
|
2011-01-26 00:10:30 +01:00
|
|
|
changed to reflect what it really is: a Django-powered ticket tracker with
|
|
|
|
|
contributors reaching far beyond Jutda.
|
|
|
|
|
|
2017-03-20 08:19:53 +01:00
|
|
|
Complete documentation is available in the docs/ directory,
|
|
|
|
|
or online at http://django-helpdesk.readthedocs.org/.
|
2011-02-05 00:13:37 +01:00
|
|
|
|
2022-05-13 09:20:31 +02:00
|
|
|
You can see a demo installation at https://django-helpdesk-demo.herokuapp.com/,
|
2017-03-20 08:19:53 +01:00
|
|
|
or run a demo locally in just a couple steps!
|
2011-02-05 05:59:24 +01:00
|
|
|
|
2017-03-20 08:19:53 +01:00
|
|
|
Demo Quickstart
|
|
|
|
|
---------------
|
|
|
|
|
|
2018-07-03 07:01:45 +02:00
|
|
|
`django-helpdesk` includes a basic demo Django project so that you may easily
|
|
|
|
|
get started with testing or developing `django-helpdesk`. The demo project
|
2017-09-13 03:16:30 +02:00
|
|
|
resides in the `demo/` top-level folder.
|
2017-03-20 08:19:53 +01:00
|
|
|
|
|
|
|
|
It's likely that you can start up a demo project server by running
|
2017-09-13 03:16:30 +02:00
|
|
|
only the command::
|
2017-03-20 08:19:53 +01:00
|
|
|
|
2019-03-14 18:25:00 +01:00
|
|
|
make rundemo
|
2017-03-20 08:19:53 +01:00
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
then pointing your web browser at `localhost:8080`.
|
2017-03-20 08:19:53 +01:00
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
For more information and options, please read the `demo/README.rst` file.
|
2008-01-07 21:22:13 +01:00
|
|
|
|
2011-02-05 05:51:34 +01:00
|
|
|
**NOTE REGARDING SQLITE AND SEARCHING:**
|
2017-09-13 03:16:30 +02:00
|
|
|
The demo project uses `sqlite` as its database. Sqlite does not allow
|
2017-03-20 08:19:53 +01:00
|
|
|
case-insensitive searches and so the search function may not work as
|
|
|
|
|
effectively as it would on other database such as PostgreSQL or MySQL
|
|
|
|
|
that does support case-insensitive searches.
|
2017-09-13 06:58:00 +02:00
|
|
|
For more information, see this note_ in the Django documentation.
|
2009-01-22 08:33:30 +01:00
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
When you try to do a keyword search using `sqlite`, a message will be displayed
|
2009-03-08 06:49:08 +01:00
|
|
|
to alert you to this shortcoming. There is no way around it, sorry.
|
|
|
|
|
|
2017-03-20 08:19:53 +01:00
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
`django-helpdesk` requires:
|
2017-09-13 06:58:00 +02:00
|
|
|
|
2021-10-18 05:49:16 +02:00
|
|
|
* Python 3.8+
|
2022-06-12 09:27:52 +02:00
|
|
|
* Django 3.2 LTS highly recommended (early adopters may test Django 4)
|
2018-03-04 08:09:54 +01:00
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
You can quickly install the latest stable version of `django-helpdesk`
|
|
|
|
|
app via `pip`::
|
2011-07-01 10:34:24 +02:00
|
|
|
|
2017-03-20 08:19:53 +01:00
|
|
|
pip install django-helpdesk
|
2011-07-01 10:34:24 +02:00
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
You may also check out the `master` branch on GitHub, and install manually::
|
2012-08-08 06:49:53 +02:00
|
|
|
|
2017-03-20 08:19:53 +01:00
|
|
|
python setup.py install
|
|
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
Either way, you will need to add `django-helpdesk` to an existing
|
|
|
|
|
Django project.
|
2017-03-20 08:19:53 +01:00
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
For further installation information see `docs/install.html`
|
|
|
|
|
and `docs/configuration.html`
|
2012-08-08 06:49:53 +02:00
|
|
|
|
2020-11-24 11:21:51 +01:00
|
|
|
Testing
|
|
|
|
|
-------
|
|
|
|
|
|
2021-08-20 08:12:55 +02:00
|
|
|
See `quicktest.py` for usage details.
|
2020-11-24 11:21:51 +01:00
|
|
|
|
2011-02-05 05:59:24 +01:00
|
|
|
Upgrading from previous versions
|
2012-08-08 06:49:53 +02:00
|
|
|
--------------------------------
|
2009-01-23 11:35:53 +01:00
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
If you are upgrading from a previous version of `django-helpdesk` that used
|
2016-10-22 00:57:14 +02:00
|
|
|
migrations, get an up to date version of the code base (eg by using
|
2012-08-08 06:49:53 +02:00
|
|
|
`git pull` or `pip install --upgrade django-helpdesk`) then migrate the database::
|
2009-01-23 11:35:53 +01:00
|
|
|
|
2011-04-27 11:57:03 +02:00
|
|
|
python manage.py migrate helpdesk --db-dry-run # DB untouched
|
2016-10-22 00:57:14 +02:00
|
|
|
python manage.py migrate helpdesk
|
2009-01-23 11:35:53 +01:00
|
|
|
|
2016-10-22 00:57:14 +02:00
|
|
|
Lastly, restart your web server software (eg Apache) or FastCGI instance, to
|
2011-04-27 11:57:03 +02:00
|
|
|
ensure the latest changes are in use.
|
2009-01-23 11:35:53 +01:00
|
|
|
|
2017-03-20 08:19:53 +01:00
|
|
|
Unfortunately we are unable to assist if you are upgrading from a
|
2017-09-13 03:16:30 +02:00
|
|
|
version of `django-helpdesk` prior to migrations (ie pre-2011).
|
2015-12-16 00:35:00 +01:00
|
|
|
|
2011-04-27 11:57:03 +02:00
|
|
|
You can continue to the 'Initial Configuration' area, if needed.
|
2009-01-23 11:35:53 +01:00
|
|
|
|
2012-08-08 06:49:53 +02:00
|
|
|
Contributing
|
|
|
|
|
------------
|
2011-02-07 08:50:47 +01:00
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
We're happy to include any type of contribution! This can be:
|
2017-09-13 06:58:00 +02:00
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
* back-end python/django code development
|
|
|
|
|
* front-end web development (HTML/Javascript, especially jQuery)
|
|
|
|
|
* language translations
|
|
|
|
|
* writing improved documentation and demos
|
2012-08-08 06:49:53 +02:00
|
|
|
|
2017-09-13 03:16:30 +02:00
|
|
|
For more information on contributing, please see the `CONTRIBUTING.rst` file.
|
2017-09-13 06:58:00 +02:00
|
|
|
|
2021-10-18 05:49:16 +02:00
|
|
|
|
|
|
|
|
Licensing
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
django-helpdesk is licensed under terms of the BSD 3-clause license.
|
|
|
|
|
See the `LICENSE` file for full licensing terms.
|
|
|
|
|
|
|
|
|
|
Note that django-helpdesk is distributed with 3rd party products which
|
|
|
|
|
have their own licenses. See LICENSE.3RDPARTY for license terms for
|
|
|
|
|
included packages.
|
|
|
|
|
|
2017-09-13 06:58:00 +02:00
|
|
|
.. _note: http://docs.djangoproject.com/en/dev/ref/databases/#sqlite-string-matching
|
2020-11-24 11:21:51 +01:00
|
|
|
|
