[ ExoCrew Home ]     [ Forums ]     [ PHP Scripts ]     [ Contact Us ]


Congratulations on getting EXO PHPDesk!,

This is the documentation file, and will help you with any of the thing you need to do, which is available as a feature in ExoPHPDesk.

For installation instructions, please consult README.HTML file.

To start with you just need to know the following stuff:

Logging in as Administrator
To login as Administrator you will need to go to http://yourdomain.com/exophpdesk/admin.php.

Logging in as Staff
To login as Staff you will need to go to http://yourdomain.com/exophpdesk/staff.php.

Logging in as Member
To login as Administrator you will need to go to http://yourdomain.com/exophpdesk/member.php .

You can't login from Admin.php as a member, and from staff.php as admin and vice versa.
From version 1.0 you can login from any of the file, and it will take you to the appropriate area.

Legends:
Admin Section -> admin.php
Staff Section -> staff.php
Member Section -> member.php

Adding/Editing/Deleting

Administrators:
To add another Administrator besides the system's main one, you'll have to login into the Admin Section*, move your mouse pointer over the "Create" button and click on Admin, or if its the Old template of ExoPHPDesk, then click on "Add Admin". Then fill in the form and submit.

To edit/delete an Administrator, login into the Admin Section*, move your mouse pointer over the "View" button, and select "Admins" from the list. Click on the Edit link on the right of the Administrator you want to edit, or delete if you want to delete the Administrator.

Staff:
To add a Staff Member, login into the Admin Section*, move your mouse pointer over the "Create" button and select Staff from the list. Fill in the form and submit it to create the staff account.

To edit/delete an Staff, login into the Admin Section*, move your mouse pointer over the "View" button, and select "Staff" from the list. Click on the Edit link on the right of the Staff you want to edit, or delete if you want to delete the Staff.

Member:
You can either register by going to yourdomain.com/exophpdesk/register.php, or login into Admin Section*, move your mouse pointer over the "Create" button and select Member from the list. Fill in the form & submit it to create the Member account.

To edit/delete an Member, login into the Admin Section*, move your mouse pointer over the "View" button, and select "Members" from the list. Click on the Edit link on the right of the Member you want to edit, or delete if you want to delete the Member.

Fields:
To add a field, login into your Admin Section*, move your mouse pointer over the "Create" button and select Fields from the list, when it takes you the the fields page, click on the edit to the right of appropriate type of field you want to add. For example, to add an extra field for tickets, click on the edit link on right of "Tickets". On the next page to add/remove field, enter details. If a field is left empty it will be removed.

F.A.Q.:
To add a F.A.Q. for knowledgebase, move your mouse pointer over the "Create" button and select F.A.Q. from the list. Fill in the form & submit it to add the F.A.Q.

To edit/delete a F.A.Q., login into the Admin Section*, move your mouse pointer over the "View" button, and select "F.A.Q." from the list. Click on the Edit link on the right of the F.A.Q. you want to edit, or delete if you want to delete the F.A.Q.

Groups:  (aka Departments)
To create a Group for knowledgebase, move your mouse pointer over the "Create" button and select "Group" from the list. Fill in the form & submit it to create the Group.

To edit/delete a Group, login into the Admin Section*, move your mouse pointer over the "View" button, and select "Groups." from the list. Click on the Edit link on the right of the Group you want to edit, or delete if you want to delete the Group.

Configurations

You get the opportunity to do the configurations when you first Install ExoPHPDesk, or you can login into your Admin Section*, move your mouse pointer over Edit and select "Configs" from the list.

Template Dir  ->  Select the right template directory from which you want to use the TPL files from, it works like choosing a template.
Language File  ->  Path to Language File, this can be helpful if you want to use some other language than English.
HelpDesk URL  ->  Internet Address to your ExoPHPDesk.
Site Name  ->  Your website/organization name.
Reply Email  ->  The reply email address which will be specified in the emails sent out of ExoPHPDesk.
ChatLog Dir  ->  A directory which will contain all the chat logs, must be chmoded to 0777 under Unix.
Registrations  ->  Here you can specify whether the registrations are opened or closed.

-- MAIL FETCHING --
Get Emails  ->  Choose here a type of mail server you want to retrieve mail from and convert them to tickets, it works like Email Piping. Choose disable if you don't want to retrieve mail from a server. It retrieves mail when an Administrator or Staff Logs in.
Mail Server Address  ->  Mail server address, ex: mail.somehost.com
Mail Server User  ->  The authorization username of the mailserver, or the mailbox username.
Mail Server Pass  ->  The authorization password of the mailserver, or the mailbox password.

Remember to "Submit" the changes you have made when you are done.

Customization

Adding A Sub Page With Same Header And Footer:
Move the file sub_page.php from extras directory to the main directory, rename it to anything you want. Consult the comments included in the file for more information.

Change Ranks Images
To change the rank images, you will need to create 5 images. Name them as they are named ago, copy/replace them to directory tpl/YOURTEMPLATE/images/.

Templates

If you need to edit/create your own templates, just keep the variables used over there. Variables in templates exist like in the following example:
{VARIABLE} OR ^VARIABLE^  (These aren't actual variables, though they are referred as variables. )
Keep in mind that if you are using a new variable, define it in lang_*.php.

There are two types of subs we used in the templates:
1. <!-EX-!> **** </!-EX->
2. [#ex **** /#ex]

First one is named as Block and second one is just a sub part of a template. Both of the above mentioned should be unchanged.

There is function usage in the template as <#functionName()/#> . They are also an important and shouldn't be edited unless you know what you are doing.

Finally, we have used logic statements as :
<if*>
if( "{foo}" == "bar" )
{

foooooooo

}
</if*>

Try not to edit the part you dont understand. Well if its HTML then you can edit it anyways.

We recommend to copy the old templates to a new folder and then Edit each file that needs to be edited, this will be a lot easy then and it will be more likely that you won't miss any required variable.

If you would like to contribute a template, please contact exocrew@gmail.com with template attached to it. You can have a copyright at the footer of the template you contributed.

We can have the helpdesk's design suit your site's design for just $20, please contact exocrew@gmail.com if you need this service.

Contact Us

The preferred way to contact us is through our Community Forums. Contact through email only if you want to discuss something like partnership, hosting etc.

Forums: http://forums.exocrew.com
E-Mail : exocrew@gmail.com