extern/django-helpdesk
1
0
Fork 1
mirror of https://github.com/django-helpdesk/django-helpdesk.git synced 2025-06-12 20:56:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation cleanup - settings page

Browse Source
This commit is contained in:
Ross Poulton 2012-08-08 17:36:34 +10:00
parent 951b105f6e
commit f2709f5166
1 changed files with 109 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

248
docs/settings.rst
View File

@ -12,7 +12,7 @@ First, django-helpdesk needs ``django.core.context_processors.request`` activat
The following settings can be changed in your ``settings.py`` file to help change the way django-helpdesk operates. There are quite a few settings available to toggle functionality within django-helpdesk. The following settings can be changed in your ``settings.py`` file to help change the way django-helpdesk operates. There are quite a few settings available to toggle functionality within django-helpdesk.
HELPDESK_DEFAULT_SETTINGS HELPDESK_DEFAULT_SETTINGS
~~~~~~~~~~~~~~~~~~~~~~~~~ -------------------------
django-helpdesk has a built in ``UserSettings`` entity with per-user 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. django-helpdesk has a built in ``UserSettings`` entity with per-user 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.
@ -29,197 +29,167 @@ If you want to override the default settings for your users, create ``HELPDESK_D
Generic Options Generic Options
=============== ---------------
These changes are visible throughout django-helpdesk These changes are visible throughout django-helpdesk
HELPDESK_REDIRECT_TO_LOGIN_BY_DEFAULT - **HELPDESK_REDIRECT_TO_LOGIN_BY_DEFAULT** When a user visits "/", should we redirect to the login page instead of the default homepage?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When a user visits "/", should we redirect to the login page instead of the default homepage?
**Default:** ``HELPDESK_REDIRECT_TO_LOGIN_BY_DEFAULT = False``
HELPDESK_PREPEND_ORG_NAME **Default:** ``HELPDESK_REDIRECT_TO_LOGIN_BY_DEFAULT = False``
~~~~~~~~~~~~~~~~~~~~~~~~~
Customize helpdesk name on a few pages, i.e., your organization.
**Default:** ``HELPDESK_PREPEND_ORG_NAME = False``
HELPDESK_KB_ENABLED - **HELPDESK_PREPEND_ORG_NAME** Customize helpdesk name on a few pages, i.e., your organization.
~~~~~~~~~~~~~~~~~~~
show knowledgebase links?
**Default:** ``HELPDESK_KB_ENABLED = True``
HELDPESK_KB_ENABLED_STAFF **Default:** ``HELPDESK_PREPEND_ORG_NAME = False``
~~~~~~~~~~~~~~~~~~~~~~~~~
Show knowledgebase links for staff users?
**Default:** ``HELPDESK_KB_ENABLED_STAFF = False``
HELPDESK_NAVIGATION_ENABLED - **HELPDESK_KB_ENABLED** show knowledgebase links?
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show extended navigation by default, to all users, irrespective of staff status?
**Default:** ``HELPDESK_NAVIGATION_ENABLED = False``
HELPDESK_NAVIGATION_STATS_ENABLED **Default:** ``HELPDESK_KB_ENABLED = True``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show 'stats' link in navigation bar for staff users?
**Default:** ``HELPDESK_NAVIGATION_STATS_ENABLED = True``
HELPDESK_SUPPORT_PERSON - **HELDPESK_KB_ENABLED_STAFF** Show knowledgebase links for staff users?
~~~~~~~~~~~~~~~~~~~~~~~
Set this to an email address inside your organization and a footer below
the 'Powered by django-helpdesk' will be shown, telling the user whom to contact
in case they have technical problems.
**Default:** ``HELPDESK_SUPPORT_PERSON = ""``
HELPDESK_TRANSLATE_TICKET_COMMENTS **Default:** ``HELPDESK_KB_ENABLED_STAFF = False``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show dropdown list of languages that ticket comments can be translated into via Google Translate?
**Default:** ``HELPDESK_TRANSLATE_TICKET_COMMENTS = False``
HELPDESK_TRANSLATE_TICKET_COMMENTS_LANG - **HELPDESK_NAVIGATION_ENABLED** Show extended navigation by default, to all users, irrespective of staff status?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List of languages to offer. If set to false, all default google translate languages will be shown.
**Default:** ``HELPDESK_TRANSLATE_TICKET_COMMENTS_LANG = ["en", "de", "fr", "it", "ru"]``
HELPDESK_SHOW_CHANGE_PASSWORD **Default:** ``HELPDESK_NAVIGATION_ENABLED = False``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show link to 'change password' on 'User Settings' page?
**Default:** ``HELPDESK_SHOW_CHANGE_PASSWORD = False``
HELPDESK_FOLLOWUP_MOD - **HELPDESK_NAVIGATION_STATS_ENABLED** Show 'stats' link in navigation bar for staff users?
~~~~~~~~~~~~~~~~~~~~~
Allow user to override default layout for 'followups' (work in progress)
**Default:** ``HELPDESK_FOLLOWUP_MOD = False``
HELPDESK_CUSTOM_WELCOME **Default:** ``HELPDESK_NAVIGATION_STATS_ENABLED = True``
~~~~~~~~~~~~~~~~~~~~~~~
Show custom welcome message in dashboard?
**Default:** ``HELPDESK_CUSTOM_WELCOME = False``
HELPDESK_AUTO_SUBSCRIBE_ON_TICKET_RESPONSE - **HELPDESK_SUPPORT_PERSON** Set this to an email address inside your organization and a footer below
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ the 'Powered by django-helpdesk' will be shown, telling the user whom to contact
Auto-subscribe user to ticket as a 'CC' if (s)he responds to a ticket? in case they have technical problems.
**Default:** ``HELPDESK_AUTO_SUBSCRIBE_ON_TICKET_RESPONSE = False``
**Default:** ``HELPDESK_SUPPORT_PERSON = ""``
- **HELPDESK_TRANSLATE_TICKET_COMMENTS** Show dropdown list of languages that ticket comments can be translated into via Google Translate?
**Default:** ``HELPDESK_TRANSLATE_TICKET_COMMENTS = False``
- **HELPDESK_TRANSLATE_TICKET_COMMENTS_LANG** List of languages to offer. If set to false, all default google translate languages will be shown.
**Default:** ``HELPDESK_TRANSLATE_TICKET_COMMENTS_LANG = ["en", "de", "fr", "it", "ru"]``
- **HELPDESK_SHOW_CHANGE_PASSWORD** Show link to 'change password' on 'User Settings' page?
**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_CUSTOM_WELCOME** Show custom welcome message in dashboard?
**Default:** ``HELPDESK_CUSTOM_WELCOME = 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``
Options shown on public pages Options shown on public pages
============================= -----------------------------
These options only change display of items on public-facing pages, not staff pages. These options only change display of items on public-facing pages, not staff pages.
HELPDESK_VIEW_A_TICKET_PUBLIC - **HELPDESK_VIEW_A_TICKET_PUBLIC** Show 'View a Ticket' section on public page?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show 'View a Ticket' section on public page? **Default:** ``HELPDESK_VIEW_A_TICKET_PUBLIC = True``
**Default:** ``HELPDESK_VIEW_A_TICKET_PUBLIC = True``
HELPDESK_SUBMIT_A_TICKET_PUBLIC - **HELPDESK_SUBMIT_A_TICKET_PUBLIC** Show 'submit a ticket' section & form on public page?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show 'submit a ticket' section & form on public page? **Default:** ``HELPDESK_SUBMIT_A_TICKET_PUBLIC = True``
**Default:** ``HELPDESK_SUBMIT_A_TICKET_PUBLIC = True``
HELPDESK_SHOW_KB_ON_HOMEPAGE - **HELPDESK_SHOW_KB_ON_HOMEPAGE** Should we should the KB categories on the homepage?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Should we should the KB categories on the homepage? **Default:** ``HELPDESK_SHOW_KB_ON_HOMEPAGE = False``
**Default:** ``HELPDESK_SHOW_KB_ON_HOMEPAGE = False``
Options that change ticket updates Options that change ticket updates
================================== ----------------------------------
HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE - **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.
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``
**Default:** ``HELPDESK_ALLOW_NON_STAFF_TICKET_UPDATE = False``
HELPDESK_SHOW_EDIT_BUTTON_FOLLOW_UP - **HELPDESK_SHOW_EDIT_BUTTON_FOLLOW_UP** Show edit buttons in ticket follow ups?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show edit buttons in ticket follow ups? **Default:** ``HELPDESK_SHOW_EDIT_BUTTON_FOLLOW_UP = True``
**Default:** ``HELPDESK_SHOW_EDIT_BUTTON_FOLLOW_UP = True``
HELPDESK_SHOW_DELETE_BUTTON_SUPERUSER_FOLLOW_UP - **HELPDESK_SHOW_DELETE_BUTTON_SUPERUSER_FOLLOW_UP** Show delete buttons in ticket follow ups if user is 'superuser'?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show delete buttons in ticket follow ups if user is 'superuser'?
**Default:** ``HELPDESK_SHOW_DELETE_BUTTON_SUPERUSER_FOLLOW_UP = False``
HELPDESK_SHOW_EDIT_BUTTON_TICKET_TOP **Default:** ``HELPDESK_SHOW_DELETE_BUTTON_SUPERUSER_FOLLOW_UP = False``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show ticket edit button on top of ticket description?
**Default:** ``HELPDESK_SHOW_EDIT_BUTTON_TICKET_TOP = True``
HELPDESK_SHOW_DELETE_BUTTON_TICKET_TOP - **HELPDESK_SHOW_EDIT_BUTTON_TICKET_TOP** Show ticket edit button on top of ticket description?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show ticket delete button on top of ticket description?
**Default:** ``HELPDESK_SHOW_DELETE_BUTTON_TICKET_TOP = True``
HELPDESK_SHOW_HOLD_BUTTON_TICKET_TOP **Default:** ``HELPDESK_SHOW_EDIT_BUTTON_TICKET_TOP = True``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show hold / unhold button on top of ticket description?
**Default:** ``HELPDESK_SHOW_HOLD_BUTTON_TICKET_TOP = True``
HELPDESK_UPDATE_PUBLIC_DEFAULT - **HELPDESK_SHOW_DELETE_BUTTON_TICKET_TOP** Show ticket delete button on top of ticket description?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Make all updates public by default? This will hide the 'is this update public' checkbox.
**Default:** ``HELPDESK_UPDATE_PUBLIC_DEFAULT = True``
HELPDESK_STAFF_ONLY_TICKET_OWNERS **Default:** ``HELPDESK_SHOW_DELETE_BUTTON_TICKET_TOP = True``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Only show staff users in ticket owner drop-downs?
**Default:** ``HELPDESK_STAFF_ONLY_TICKET_OWNERS = False``
HELPDESK_STAFF_ONLY_TICKET_CC - **HELPDESK_SHOW_HOLD_BUTTON_TICKET_TOP** Show hold / unhold button on top of ticket description?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Only show staff users in ticket cc drop-down? **Default:** ``HELPDESK_SHOW_HOLD_BUTTON_TICKET_TOP = True``
**Default:** ``HELPDESK_STAFF_ONLY_TICKET_CC = False``
- **HELPDESK_UPDATE_PUBLIC_DEFAULT** Make all updates public by default? This will hide the 'is this update public' checkbox.
**Default:** ``HELPDESK_UPDATE_PUBLIC_DEFAULT = True``
- **HELPDESK_STAFF_ONLY_TICKET_OWNERS** Only show staff users in ticket owner drop-downs?
**Default:** ``HELPDESK_STAFF_ONLY_TICKET_OWNERS = False``
- **HELPDESK_STAFF_ONLY_TICKET_CC** Only show staff users in ticket cc drop-down?
**Default:** ``HELPDESK_STAFF_ONLY_TICKET_CC = False``
Staff Ticket Creation Settings Staff Ticket Creation Settings
============================== ------------------------------
HELPDESK_CREATE_TICKET_HIDE_ASSIGNED_TO - **HELPDESK_CREATE_TICKET_HIDE_ASSIGNED_TO** Hide the 'assigned to' / 'Case owner' field from the 'create_ticket' view? It'll still show on the ticket detail/edit form.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Hide the 'assigned to' / 'Case owner' field from the 'create_ticket' view? It'll still show on the ticket detail/edit form. **Default:** ``HELPDESK_CREATE_TICKET_HIDE_ASSIGNED_TO = False``
**Default:** ``HELPDESK_CREATE_TICKET_HIDE_ASSIGNED_TO = False``
Dashboard Settings Dashboard Settings
================== ------------------
These will change the way the *dashboard* is displayed to staff users when they login. These will change the way the *dashboard* is displayed to staff users when they login.
HELPDESK_DASHBOARD_SHOW_DELETE_UNASSIGNED - **HELPDESK_DASHBOARD_SHOW_DELETE_UNASSIGNED** Show delete button next to unassigned tickets?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show delete button next to unassigned tickets?
**Default:** ``HELPDESK_DASHBOARD_SHOW_DELETE_UNASSIGNED = True``
HELPDESK_DASHBOARD_HIDE_EMPTY_QUEUES **Default:** ``HELPDESK_DASHBOARD_SHOW_DELETE_UNASSIGNED = True``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Hide empty queues in dashboard overview?
**Default:** ``HELPDESK_DASHBOARD_HIDE_EMPTY_QUEUES = True``
HELPDESK_DASHBOARD_BASIC_TICKET_STATS - **HELPDESK_DASHBOARD_HIDE_EMPTY_QUEUES** Hide empty queues in dashboard overview?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show basic ticket stats on dashboard? This may have performance implications for busy helpdesks. **Default:** ``HELPDESK_DASHBOARD_HIDE_EMPTY_QUEUES = True``
**Default:** ``HELPDESK_DASHBOARD_BASIC_TICKET_STATS = False``
- **HELPDESK_DASHBOARD_BASIC_TICKET_STATS** Show basic ticket stats on dashboard? This may have performance implications for busy helpdesks.
**Default:** ``HELPDESK_DASHBOARD_BASIC_TICKET_STATS = False``
Footer Display Settings Footer Display Settings
======================= -----------------------
HELPDESK_FOOTER_SHOW_API_LINK - **HELPDESK_FOOTER_SHOW_API_LINK** Show link to API documentation at bottom of page?
Show link to API documentation at bottom of page?
**Default:** ``HELPDESK_FOOTER_SHOW_API_LINK = True``
HELPDESK_FOOTER_SHOW_CHANGE_LANGUAGE_LINK **Default:** ``HELPDESK_FOOTER_SHOW_API_LINK = True``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Show the 'change language' link at bottom of page? Useful if you have a multilingual helpdesk. - **HELPDESK_FOOTER_SHOW_CHANGE_LANGUAGE_LINK** Show the 'change language' link at bottom of page? Useful if you have a multilingual helpdesk.
**Default:** ``HELPDESK_FOOTER_SHOW_CHANGE_LANGUAGE_LINK = False``
**Default:** ``HELPDESK_FOOTER_SHOW_CHANGE_LANGUAGE_LINK = False``
Default E-Mail Settings Default E-Mail Settings
======================= -----------------------
The following settings default to ``None`` but can be set as defaults, rather than setting them per-queue. The following settings default to ``None`` but can be set as defaults, rather than setting them per-queue.
``QUEUE_EMAIL_BOX_TYPE`` - ``QUEUE_EMAIL_BOX_TYPE``
``QUEUE_EMAIL_BOX_SSL`` - ``QUEUE_EMAIL_BOX_SSL``
``QUEUE_EMAIL_BOX_HOST```` - ``QUEUE_EMAIL_BOX_HOST````
``QUEUE_EMAIL_BOX_USER`` - ``QUEUE_EMAIL_BOX_USER``
``QUEUE_EMAIL_BOX_PASSWORD`` - ``QUEUE_EMAIL_BOX_PASSWORD``