Getting Started with JoomHelpDesk

Parent Category: Documentation JoomHelpdesk Documentation Last Updated: 03 February 2026 Hits: 305

This guide walks you through installing JoomHelpDesk, navigating the admin panel, and completing the initial setup so your helpdesk is ready for users.

What is JoomHelpDesk?

JoomHelpDesk is a complete helpdesk and knowledge management solution for Joomla 5.x, developed by JoomBoost. It provides ticket-based support, a knowledge base, FAQ system, announcements, glossary, and testimonials -- all managed from the Joomla frontend.

The full package includes:

1 component -- com_joomhelpdesk (the core helpdesk engine with both administrator and frontend sides)
8 site modules -- display widgets for your frontend pages:
- mod_joomhelpdesk_advsearch -- Advanced Search
- mod_joomhelpdesk_announce -- Announcements
- mod_joomhelpdesk_catprods -- Category Products
- mod_joomhelpdesk_faqs -- FAQs
- mod_joomhelpdesk_kbart -- Knowledge Base Articles
- mod_joomhelpdesk_kbprodinfo -- Knowledge Base Product Info
- mod_joomhelpdesk_support -- Support Widget
- mod_joomhelpdesk_test -- Testimonials
11 plugins -- extend Joomla functionality:
- plg_system_joomhelpdesk -- Core system plugin (enabled by default)
- plg_system_joomhelpdesk_cron -- Background cron tasks
- plg_content_joomhelpdesk_glossary -- Glossary content integration
- plg_search_joomhelpdesk_announce -- Search: Announcements
- plg_search_joomhelpdesk_faqs -- Search: FAQs
- plg_search_joomhelpdesk_glossary -- Search: Glossary
- plg_search_joomhelpdesk_kb -- Search: Knowledge Base
- plg_finder_joomhelpdesk_announce -- Smart Search: Announcements
- plg_finder_joomhelpdesk_faq -- Smart Search: FAQs
- plg_finder_joomhelpdesk_glossary -- Smart Search: Glossary
- plg_finder_joomhelpdesk_kb -- Smart Search: Knowledge Base

Note: All user-facing support and admin support activity happens on the frontend. The Joomla backend (Administrator panel) is used only for configuration and setup.

Installation

Download the pkg_joomhelpdesk_v{VERSION}_j4.zip package file from JoomBoost.
Log in to your Joomla Administrator panel.
Navigate to System > Install > Extensions.
Upload the package ZIP file using the Upload Package File tab.
Joomla will install the component, all 8 modules, and all 11 plugins automatically.
After installation, the core system plugin plg_system_joomhelpdesk is enabled by default. The remaining plugins are installed but disabled -- enable them as needed from System > Manage > Plugins.

Accessing the Admin Panel

After installation, access the JoomHelpDesk configuration area at:

Administrator > Components > JoomHelpDesk

Or navigate directly to:

/administrator/index.php?option=com_joomhelpdesk

The admin sidebar organizes all configuration areas into logical groups:

Section Group	Menu Items
Dashboard	Dashboard
General	Permissions, Email Templates, Custom Fields, Main Menu Items, Moderation
Support Tickets	Products, Categories, Departments, Priorities, Groups, Statuses, Email Accounts, Help Texts
Knowledge Base	KB Categories, KB Articles
FAQs	FAQ Categories, FAQs
Announcements	Announcements
Glossary	Glossary
Testimonials	Products, Moderation
Settings	Settings, Templates, View Settings
Admin	Cron Log, Email Log, Attachment Cleanup, Backup, Plugins

Initial Setup Checklist

Follow these steps in order to configure your helpdesk from scratch.

Step 1: Configure General Settings

Navigate to Settings > General tab.

This tab contains several fieldsets:

General Settings

Setting	Description	Default
SEF Compatibility	Enable SEF (Search Engine Friendly) URL compatibility mode	Off
CSS Indirect	Load CSS indirectly for template compatibility	Off
Hide Warnings	Suppress PHP warning messages on the frontend	Off
Attachment Location	Filesystem path where ticket attachments are stored	(component default)
Debug Reports	Enable debug output for report generation	Off
Reports Separator	CSV separator character for exported reports	`,`
Search Extra Like	Enable extended LIKE matching in search queries	Off

Date Settings

Setting	Description	Default
Short Date/Time	PHP date format for short date-time display (e.g., `d/m/Y, H:i`)	Joomla LC4 + time
Long Date/Time	PHP date format for long date-time display	Joomla LC3 + time
Short Date	PHP date format for short date only	Joomla LC4
Long Date	PHP date format for long date only	Joomla LC3
Timezone Offset	Numeric offset from server timezone (e.g., `+1`, `-5`)	(empty)

Use the Test Date Formats button to preview how your chosen formats will render.

Comments Settings

Setting	Description	Default
Captcha Type	Captcha for guest comments: None, Built-in, or reCAPTCHA	None
Hide Add Comment	Hide the "Add Comment" form by default	Off
Comments Moderation	Who is moderated: All, Guests only, Registered + Guests, or None	All
Who Can Add Comments	Who can post comments: Anyone or Registered Users Only	Anyone
Email on Comment	Email address to notify when a new comment is posted	(empty)
Comment Use Email	Show email field in comment form	Off
Comment Use Website	Show website field in comment form	Off

reCAPTCHA Settings

Setting	Description	Default
reCAPTCHA Public Key	Your Google reCAPTCHA site key	(empty)
reCAPTCHA Private Key	Your Google reCAPTCHA secret key	(empty)

Setting	Description	Default
Show "Support Tickets" Section	Display the Support Tickets section on the frontend main menu	On
Show "Moderate" Section	Display the Moderate section on the frontend main menu	On

WYSIWYG Editor Settings

Setting	Description	Default
Toolbar Theme	Editor toolbar style: Default, Default Dark, Office, Office Toolbar, Square	Default
Use Emoticons	Enable emoticon picker in the editor	Off
Button Hide	Comma-separated list of editor buttons to hide	(empty)

Email Sending Settings

JoomHelpDesk can use the Joomla global mail settings, or you can override them with dedicated SMTP configuration for helpdesk emails only.

Setting	Description	Default
Multiple Email Sending	How to send to multiple recipients: Separate Emails, Single TO, or BCC	Separate Emails
Override Joomla Email Settings	Use JoomHelpDesk's own mail settings instead of Joomla Global Configuration	Off
Mailer Type	PHP Mail, Sendmail, or SMTP	PHP Mail
From Email	Sender email address	(empty)
From Name	Sender display name	(empty)
SMTP Authentication	Enable SMTP authentication	Off
SMTP Security	None, SSL, or TLS	None
SMTP Port	SMTP server port number	(empty)
SMTP Host	SMTP server hostname	(empty)
SMTP Username	SMTP login username	(empty)
SMTP Password	SMTP login password	(empty)
Sendmail Path	Path to sendmail binary (when using Sendmail mailer)	(empty)

A Send Test Email button is available to verify your configuration. Enter a test email address and click the button to confirm delivery.

For more details, see Email Configuration.

Setting	Description	Default
Sticky Menu Items	Control how internal links are generated: Ignore, Include specific menu items, or Exclude specific menu items	Ignore

Step 2: Configure Support Settings

Navigate to Settings > Support tab.

The Support settings tab contains six sub-tabs:

Sub-Tab	What It Controls
Opening Tickets	Rules for who can open tickets, guest ticket settings, required fields, attachment limits, default values
Users	User-facing display options, user profile settings, user registration behavior
Handlers	Support agent/handler settings, assignment rules, handler notifications
Emails	Email notification triggers, email content preferences, reply-by-email settings
General	Ticket numbering, auto-close rules, SLA settings, ticket behavior
Visual	Frontend ticket display options, pagination, layout preferences

Step 3: Create Products

Navigate to Support Tickets > Products in the admin sidebar.

Products are the top-level organizational unit in JoomHelpDesk. Every ticket belongs to a product. Think of products as the services, software, or business areas your helpdesk supports.

Click New in the toolbar.
Enter the product name and details.
Configure product-specific settings (custom fields, departments, handlers).
Save the product.

Create at least one product before users can submit tickets.

Step 4: Create Departments

Navigate to Support Tickets > Departments in the admin sidebar.

Departments are linked to products and help route tickets to the correct team.

Click New in the toolbar.
Enter the department name.
Assign the department to one or more products.
Save the department.

Step 5: Create Categories (Optional)

Navigate to Support Tickets > Categories in the admin sidebar.

Categories provide an additional layer of ticket organization within products. They are optional but useful for large helpdesks.

Click New in the toolbar.
Enter the category name and assign it to a product.
Save the category.

Step 6: Review Ticket Statuses

Navigate to Support Tickets > Statuses in the admin sidebar.

Default statuses are pre-installed during setup (e.g., Open, In Progress, Closed). Review them and adjust names, colors, or ordering as needed. You can also create new custom statuses.

Step 7: Review Priorities

Navigate to Support Tickets > Priorities in the admin sidebar.

Default priorities are pre-installed (e.g., Low, Medium, High, Urgent). Review and customize them to match your support workflow.

Step 8: Set Up Email Templates

Navigate to General > Email Templates in the admin sidebar.

Email templates control the content of notification emails sent by JoomHelpDesk (e.g., new ticket confirmation, reply notifications, status changes).

Select an email template to edit.
Customize the subject line and body content using the available template variables.
Save the template.

For the full list of template variables and configuration options, see Email Configuration.

Step 9: Configure Email Accounts

Navigate to Support Tickets > Email Accounts in the admin sidebar.

Email accounts enable the email-to-ticket feature, allowing users to create or reply to tickets by sending email. JoomHelpDesk connects to a POP3 or IMAP mailbox to check for incoming messages.

Click New in the toolbar.
Enter the email account details (server, port, protocol, username, password).
Assign the email account to a product and/or department.
Save and test the connection.

Note: The cron plugin (plg_system_joomhelpdesk_cron) must be enabled for automatic email checking.

Step 10: Create Custom Fields (If Needed)

Navigate to General > Custom Fields in the admin sidebar.

Custom fields let you collect additional information on tickets beyond the default fields. You can create text fields, dropdowns, checkboxes, file uploads, and more.

For a full guide, see Custom Fields Guide.

Step 11: Set Up Users and Assign Handlers

Navigate to General > Permissions in the admin sidebar.

Users are your Joomla site members who submit tickets.
Handlers (support agents) are users with permission to manage and respond to tickets.

Assign handler roles through Joomla user group permissions. Handlers can be assigned to specific products or departments.

You need at least one Joomla menu item pointing to JoomHelpDesk so users can access the helpdesk on the frontend.

Go to Menus > (your menu) > New.
Click Select next to "Menu Item Type".
Choose JoomHelpDesk > JoomHelpDesk.
Enter a title (e.g., "Support", "Help Desk").
Save the menu item.

This single menu item provides access to the full helpdesk frontend, including support tickets, knowledge base, FAQs, announcements, and all other sections that are enabled.

Frontend URL Structure

All user-facing features are served on the frontend through the menu item you created. The helpdesk frontend includes:

Support Tickets -- users open, view, and manage their tickets
Admin Support Panel -- handlers manage and respond to tickets
Knowledge Base -- categorized reference articles
FAQs -- frequently asked questions
Announcements -- news and updates
Glossary -- term definitions
Testimonials -- user feedback

The backend (Joomla Administrator) is used exclusively for configuration, not for day-to-day support operations.

Settings Tabs Overview

The main Settings page (under Settings in the admin sidebar) has eight tabs:

Tab	Purpose
General	Core component behavior: SEF compatibility, attachments, date formats, timezone, WYSIWYG editor, email sending, main menu visibility, captcha, comments
Visual	Page title HTML templates (H1, H2, H3 styles), page header and footer content
Support	All ticket-related settings, organized into sub-tabs: Opening Tickets, Users, Handlers, Emails, General, Visual
Announcements	Settings for the announcements feature (display options, permissions)
FAQs	Settings for the FAQ system (display options, voting, comments)
Glossary	Settings for the glossary feature (display options, content plugin behavior)
Knowledge Base	Settings for the knowledge base (display options, categories, comments)
Testimonials	Settings for the testimonials feature (display options, moderation)

Tips

Clear Joomla cache after changing settings or updating files. Go to System > Clear Cache in the Joomla Administrator.
Enable debug mode during setup by turning on Joomla's Global Configuration debug mode. This helps identify issues with templates or permissions.
Start simple. Create one product, one department, and one menu item. Verify that ticket creation and email notifications work before adding complexity.
Test email delivery using the "Send Test Email" button in Settings > General before going live. Email problems are the most common setup issue.
Enable plugins selectively. Only enable the search and finder plugins for the sections you actively use (KB, FAQs, Glossary, Announcements) to avoid unnecessary processing.
Back up regularly. Use the Backup feature in the admin sidebar (Admin > Backup) to export your helpdesk data.
Customize the frontend menu. Use Main Menu Items (General > Main Menu Items) to control which sections appear in the helpdesk navigation, and use the Main Menu Settings in Settings > General to show or hide the Support Tickets and Moderate sections.
Translations. JoomHelpDesk supports multilingual sites. See the Translation Guide for details on translating the frontend and backend strings.

Documentation

Find documentation for our Joomla extensions on this page.