Skip to content

Latest commit

 

History

History
236 lines (181 loc) · 15.4 KB

README.md

File metadata and controls

236 lines (181 loc) · 15.4 KB
Raw

Panic Help Desk

This is a ticketing system for Laravel PHP framework (from version 5 to 8): It is based on Kordy/Ticketit. We have kept almost all ticketit features and added many additional functionalities, like file attachments, ticket tags, scheduling, filtering and an advanced search form. This package uses an own route, "/PanicHD" which can be modified after installation, so it may be installed in your existent Laravel project.

Table of contents

Description

Overview

Panic Help Desk is a ticketing system that may be integrated on any Laravel app. A "ticket" can be any specific issue, thread, bug or whatever you need. It includes some general fields that may be useful to classify it and has some interaction possibilities between the user that creates it and the ticket managers.

General view

This ticketing system is actually mean to be used in a corporate support environment, by these reasons:

  • Only registered users or ticket managers are able to add tickets. For any manager, a ticket can only be assigned to an owner which is registered.
  • We have included all required asset files in the package structure because we want it to be usable in our LAN even without working internet connection (think about IT corporate support)

Translations

This package has got up to date translations to Brazillian Portuguese, Catalan, English and Spanish. There are more translations included, but they're oldier and some menues may not be translated yet.

PanicHD used language will be the one you have configured within Laravel.

You may also create your own language files. We encourage you to make your own language pack and add a pull request to our dev branch, to let other PanicHD members from your country have it.

A ticket step by step example

  1. A user registers a new ticket for a specific issue
  2. The ticket gets automatically assigned to an agent (a ticket manager) that receives an e-mail notification.
  3. The agent contacts the user to give support. After the support tasks, leaves the ticket opened in "User pending" status because a confirmation that the issue is solved is needed
  4. The user confirms within the ticket that it is solved. He can do it by directly completing the ticket or making a new comment
  5. In any case, the agent will receive an e-mail notification with the user update
  6. If the ticket was left active, the agent completes it
  7. Both the agent and the user will see the ticket in the Complete list for future reference.

Features

This is a synopsis of the main PanicHD features. For detailed descriptions, example screenshots and general reference, please read our Current features page in the wiki

  • Three user roles: Member, Agent and Admin

  • PanicHD ticket fields

    • Basic set that any member can fill up when registering a new ticket:

      • Subject
      • Description: It may contain text, html or even directly pasted screenshots
      • Category
      • Attached files

    • classification fields, like: Priority, status, tags

    • Time related fields:

      • Start date: When the ticket activity may start. By default it is the creation date
      • Limit date: When the ticket expires. It is used for schedule ticket filtering

    • Any of the ticket managers may view / edit all the ticket fields

    • A manager may add a ticket assigning it to any owner (any registered user)

    • A manager may add a user hidden ticket (or switch a visible ticket to hidden):

      • It may be also assigned to any owner
      • The owner (if it's not also an agent on the ticket category) won't be able to view the ticket
      • This kind of owner will not receive any e-mail notification

  • User / Managers communication

    • By comments added from both of them within a ticket card
    • By e-mail notifications: All of them will receive notifications relative to relevant changes in the ticket made by any of them
    • Manager may add user hidden messages called "internal notes". If the ticket is assigned to another agent, he will receive a related e-mail notification also

  • Ticket filters

    • All ticket lists include a filter panel that lets you use a specific criteria in some relevant fields (Calendar, category, agent)
    • These filters are kept in user session until you change or deletes them
    • Only members with permissions to manage at least one category will be able to use the filter panel
    • You may activate a field by URL, as we explain in the wiki

  • Ticket search

    • There is a dedicated search form where you may specify it by any of the ticket related fields
    • We have added some advanced search options, like search text in any field, text in comments, text in attachment fields, search by specific date criteria...
    • After executing the search, you will have a button with a permanent link to it, which has all specified parameters and values in URL
    • It is enabled for all members with permissions

  • For Admins

    • Any classification element may be edited
    • They can easily manage categories and assigned Agents

  • For developers

    • There is a configuration settings menu that directly comes from Ticketit. It is so useful and flexible to configure the package at your own desire even without altering the package files

    • We have added some useful Artisan commands to help you make your own local tests. Click the link or type in the Laravel console the following command:

      php artisan panichd

Installing

1- Requirements

  • Laravel 5.1 or higher including:

    • Laravel auth with at least one user registered
    • Model App\User.php that uses users table. It is added with Laravel auth by default and PanicHD requires it to be there. It seems that some admin panels change it to App\Models\User.php or maybe other routes.
    • Valid email configuration (Needed for PanicHD notification emails)

  • Composer (the PHP dependency manager)

  • MySQL 5.7 or 8.x with disabled "strict mode" or specifying all or required MySQL modes except "ONLY_FULL_GROUP_BY". For either option, open Laravel's config\database.php and go to "connections" -> "mysql", and then:

    • To disable strict mode: Set "strict" to "false"
    • To specify MySQL modes:
      • Keep "strict" to "true"
      • Add "modes" key if not exists
      • If "modes" didn't exist, add all MySQL modes, except ONLY_FULL_GROUP_BY.
      • If "modes" was already configured, just comment or delete "ONLY_FULL_GROUP_BY"

2- If Kordy/Ticketit is installed

If it's installed in the same Laravel project you want to install Panic Help Desk, Panic Help Desk will replace it, reusing it's database tables and keeping registered tickets. Before installing PanicHD, you will have to uninstall Kordy/Ticketit following these steps:

  1. Open composer.json file at laravel root folder. Remove the line that reffers to kordy/ticketit in the "require" section
  2. Open config/app.php. Remove the line that contains "TicketitServiceProvider"
  3. Via command line in laravel root, execute: composer update kordy/ticketit
  4. Delete all possible remaining refferences and files that you may have in your Laravel project (Published files? Refferences in Laravel files?)

3- Add and enable PanicHD package

  1. Open a command line in the Laravel folder and type: composer require panichd/panichd

  2. If you are using Laravel 5.4 or lower, you will have to add the service provider. In this case, Open config/app.php. In the "Providers" section, add:

    PanicHD\PanicHD\PanicHDServiceProvider::class,

4- Configure it

At this point, if you think you typed enough commands, the web installer comes to rescue you ;) But if you're a tough and experienced Laravel coder, please forget this and jump to Complete installation with command line section.

Option A: With our web installer

To access the web installer you just have to:

  1. Log in the Laravel app via web browser
  2. access URL http://your-laravel-app-URL/panichd
  3. Read and follow the installation steps

Option B: Using command line (advanced users)

B.1- Create the attachments folders:

  1. Access "storage" folder inside Laravel root and create the subfolder: panichd_attachments
  2. Access storage\app\public and create the subfolder: panichd_thumbnails

B.2- Execute these commands:

  1. Publish and install migrations

    1.1 Publish migrations: php artisan vendor:publish --tag=panichd-db

    1.2 Execute migrations: php artisan migrate

  2. Fill up "panichd_settings" table with the required defaults seeder:

    php artisan db:seed --class=PanicHD\\PanicHD\\Seeds\\SettingsTableSeeder

  3. If Kordy/Ticketit was installed, Patch settings table with:

php artisan db:seed --class=PanicHD\\PanicHD\\Seeds\\SettingsPatch

  1. Enable "panichd_thumbnails" folder access:

    php artisan storage:link

  2. Publish included assets:

    php artisan vendor:publish --tag=panichd-public

B.3- If your have done a clean PanicHD installation, you must enable at least one administrator for it by setting users table row/s "panichd_admin" field value to 1.

B.4- Access http://your-laravel-app-URL/panichd in your browser

5- App start-up

Add demostration data

You may use our demo data seeder to test the package quickly. The following command creates some fake users, tickets and other stuff which you may browse, edit and do whatever you want:

 `php artisan db:seed --class=PanicHD\\PanicHD\\Seeds\\DemoDataSeeder`

To delete all PanicHD demo content use this command:

php artisan panichd:demo-rollback

Add our basic parameters set

Before you can create tickets, you must have added at least one Priority, one Status and one Category. You may use our basic seeder to fill these lists with default elements meant for general usage. All added items will be editable. To use it type the following command:

php artisan db:seed --class=PanicHD\\PanicHD\\Seeds\\Basic

Configurations and Laravel integration

Contributing

Please read our contributing reference.

Built with

If some day this package is as useful to someone as other ones like these have been to us, our debt will for sure still be enormous, but also we'd be very happy!

Acknowledgements

Thanks to Kordy and his collaborators for building up Kordy/Ticketit and sharing it on GitHub. Without it, Panic Help Desk simply won't exist.

A big Thank You also to all the guys at online communities like StackOverflow that do their best everyday to help others like me on their daily coding headaches.