1. Start
  2. System Requrements
  3. Installation
  4. Local Server Installation
  5. First Steps
  6. Cronjob
  7. Paypal IPN
  8. FAQ
  9. Sources and Credits

Freelance Cockpit

Project Management System


Thank you for purchasing Freelance Cockpit. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form. Thanks so much!

System Requrements


Your server need to meet the following requirements in order to run Freelance Cockpit.

 

 

 

 

 

 

 

 

Installation


  1. Connect to your web server using any FTP program (ie. FileZilla) or the webinterface of your webhost and upload all files and folders which are inside the "FC2 Application" folder from the .zip file you have downloaded from Codecanyon. If you like to install Freelance Cockpit on your local computer using WAMP, make sure you first read Local Server Installation 


     

  2. The folder "files" and it's subfolders must have write permissions, so just give the folder write permissions (777).


     

  3. Go to your web browser and enter your domain plus "/install" i.e. http://www.your-domain.com/install

  4. Your System will now be checked. If your server meets all requirements, go ahead to the next step. If you have warning messages go to FAQ.



     

  5. Enter your item purchase code. Click on the blue icon to get an idea where you can find your item purchase code.


     

  6. Enter your MYSQL configuration. If the database you entered does not exist, the system will try to create it. This might not work when your webhost does not allow to create new databases. Please use an existing database in this case or create the database using the web interface of your webhost.




     

  7. Fill the form with your details.


     

  8. That's it! Now go to the login page and log yourself in.


     

  9. If you get an error 404 or 500 page after clicking on "Login", means that you need to change your .htaccess file.
    Just search for your error on the FAQ page and change the .htaccess file as descried. Feel free to contact me via my profile page if you are not sure which .htaccess configuration you need to use.



 

 

 

 

 

 

 

Local Server Installation


WAMP Server

If you like to install Freelance Cockpit on your local machine using WAMP Server you need to make sure to enable the apache rewrite_module. Click on the WAMP icon in your taskbar and click on Apache -> Apache modules -> rewrite_module


 

When the rewrite_module is not active you will get the following error message if you try to access the Freelance Cockpit installation tool.

Internal Server Error
The server encountered an internal error or misconfiguration and was unable to complete your request.
Please contact the server administrator, admin@localhost and inform them of the time the error occurred, and anything you might have done that may have caused the error.
More information about this error may be available in the server error log.

 

You also need to make sure that the Curl extention is loaded. Just open your php.ini (...wamp\bin\apache\apache2.2.22\bin\php.ini) and remove the semicolon in front of the following extention:  extension=php_curl.dll


 

 

 

 

 

 

 

 

First Steps


  1. Login using "admin" and "password".



     
  2. Click on John Doe in the left upper corner and change your password and personal details like first name etc.




     
  3. Now go to Settings and change the default configuration so it fits your needs.



     
  4. Now go to "Clients" and create a "New Company".


     
  5. Fill in all details and click on "Save"


     
  6. You new client company has been created. Click on "Add Contact" in order to create a contact. Client contacts can login to the client area. 


     
  7. Fill in all the contact details and grant permissions to the modules the client contact should have access to if they login to the client area. If you leave the "Profile Picture" blank the system will look for a Gravatar using the email address of the client contact.


     
  8. If you want to delete or edit a client contact, use the "Action" buttons on the right.
  9. Go to "Projects" and create a new project.


     
  10. Just fill in all details and select if the process should be calculated via the tasks (Calculate progress). If you enable it you won't be able to set the progress manually!


     
  11. In order to quickly access your project you can add it to the "Quick Access" list by just clicking the "Add to Quick Access" button on top. The project should appear on the left "Quick Access" list.
  12. The time you spent on a project can be tracked with every single project. Just use the timer button on top of the project overview. If you click on start the timer will run even if you close your browser. It will run until you click on stop, if you click on start again the timer will resume from the time you have stopped it.
  13. Click on "Add task" on the right hand side to add a new task to the project. Select if the task will be visible for the client and  to whom you like to assign the task to.


     
  14. On the media table you can upload and share files with your clients. The upload is not restricted to any file type or size. Your client can also upload files and leave comments.
     
  15. You can also assign projects to agents.


     
  16. Just go to Invoices and create a new invoice. 


     
  17. Fill all fields and click on save. The discount value can either be a normal value or percentage if you add the % symbol.

  18. Click on the row of the invoice you have just created to get to the Invoice overview. Here you can add items, preview the invoice and send it directly to the assigned client. The invoice status will change automatically to "Sent" if you send the invoice to the client. The "Send Invoice to Client" button will be hidden when you mark the invoice as "Paid" or if your client has paid via paypal.



     
  19. Click "Add Item" in order to add your new item.






     
  20. Go to Subscriptions and create a new subscription. 


     
  21. Fill all fields and choose a frequency for the recurring invoices.

  22. Add a new item to the Subscription.





     
  23. The next payment shows you the date when the next invoice will be created (cronjob needs to be running).


     
  24. If you have Paypal activated your client can subscribe via Paypal.


     
  25. On Quotations you can view the quotation form and send the link to your potential clients so they can submit a quotation request.




     
  26. The settings page will give you access to all the important system settings.



     
  27. You can edit all email templates via the Templates tab.



     
  28. If you like to use Paypal make sure you have activated the paypal feature.



     
  29. You can create new users on the users tab. in order to create a new user click on "New User".


     
  30. Make sure you select the required module permissions. Admins can see all projects. Non admins can only see projects they are assigned to.


     
  31. If a system update is available you can download and install it right from the "System Updates".


     
  32. You can make a database update with a simple click on "Backup Database". If you wan't to restore a previous update just click on "Restore Database".


     
     
  33. Please go to Cronjob in order to setup automatic tasks (required for subscriptions).



     
  34. You can edit the css style directly via the "Customize" tab. 



     
  35. Here you can check the log entrys. Make sure you clear the log from time to time.


     
  36. Now go to the Ticket tab.


     
  37. The email settings depends to your email server. If you want to use a gmail (google mail) account, your settings should look like like on the screenshot below. You also need to make sure you have enabled imap in your gmail account.


     
  38. Now you can go to Tickets where you can see and create tickets. The star indicates a new unread note which has been added to a ticket if it is assigned to you.


     
  39. On the left you can see all the ticket details. The right side contains the ticket content and notes.


     

 

 

 

 

 

 

 

Basic Cronjob


The basic cronjob should run at least once a day and is used in order to activate automated tasks like recurring invoices (subscriptions) and automatic database backup. Please refer to your web host providers FAQ in order to find out how to setup a cronjob/crontab (if your hosting package includes cronjobs).

The command should look like this: wget http://www.your-domain.com/cronjob

Your hosting package does not include cronjob/crontab? No problem! There are many websites who offer free cronjob services. One of them is www.setcronjob.com.


Email Ticket Cronjob

The email ticket cronjob should run every 10 minutes and is used in order to activate email tickets.

The command should look like this (you can find your cronjob command in Settings->Ticket->Postmaster cronjob link): wget http://www.your-domain.com/postmaster -O /dev/null


How to setup a cronjob in Plesk

If your web server is running Plesk you can check out the following instruction:

 

1. Go to Tools and Settings -> Scheduled Tasks



 

2. Click on Add new Task



 

3. Enter all the details like on the screenshot below. Important - change the cronjob link (Command) to your personal one. You can find it in Freelance Cockpit under Settings -> Cronjob
Note that you have to enter "wget" in front of the command link.




 

How to setup a cronjob in cPanel

Video by SiteServing

 

 

 

 

 

Paypal IPN


If you like to use the Paypal IPN feature make sure you have added the IPN link (can be found in Settings -> Paypal) to your Paypal account. Here is a short Youtube video which explains how to set the IPN link to your Paypal account 

 

Video by WebifyWs

 

 

 

 

 

 

 

FAQ


 

If you get 404 page not found error after installation.

In this case your server needs the RewriteBase option to be set. Open the .htaccess file in the main folder and add the following line to it:
RewriteBase / 
 
The .htaccess should look like this:
 
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php/$1 [L]
RewriteBase /
 
If you have installed the application into a sub folder you need to add the sub folder name after the / 
The .htaccess file should look like this in this case:
 
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php/$1 [L]
RewriteBase /your_sub_folder/
 

On Dreamhost you have to amend the .htaccess. If you get a “No Input File” error.

The htaccess file should look like this:
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php/?$1 [L]
RewriteBase /
 

If you get “no input file specified” error on goDaddy web host

 you need to change the .htaccess as follows: 
 
<IfModule mod_rewrite.c> 
RewriteEngine On 
RewriteCond $1 !\.(gif|jpe?g|png)$ [NC] 
RewriteCond %{REQUEST_FILENAME} !-f 
RewriteCond %{REQUEST_FILENAME} !-d 
RewriteRule ^(.*)$ /index.php?/$1 [L] 
</IfModule> 
 

The following error message comes up:

Warning: Unexpected character in input: '\' (ASCII=92) state=1 in /FreelanceCockpit/sparks/php-activerecord/0.0.2/libraries/phpactiverecord.php on line 48
Parse error: syntax error, unexpected T_STRING in /FreelanceCockpit/sparks/php-activerecord/0.0.2/libraries/phpactiverecord.php on line 48

This error means that your servers PHP version is not 5.3 or higher. Contact your web host in order to update your PHP version to 5.3 or higher.
 
 

If you get a 500 Error after the installation try the following as .htaccess

RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond $1 !^(index\.php|robots\.txt)
RewriteRule ^(.*)$ /index.php?/$1 [L]

 

The "System Check" returns that the database file is not writable.

The database file contains your database configuraion and it is located under "application/config/database.php". This file must be writeable during the installation process so give the file write permission 775 using your FTP application or the web interface of your webhost. Make shure you change the permissions back to 644 once the installation is completed.

 

The "System Check" returns that one or more PHP extentions are not loaded.

Make sure you have all required PHP extentions activated. You may have to contact your web host in order to activate the missing extentions.

 

How can I change the invoice layout?

You can change the layout by changing the file called "preview.php" which is located under "appliaction/views/blackline/invoices/". Only change this file if you have further HTML and PHP knowledge!

 

 

 

 

 

 

 

 

 

Sources and Credits


I've used the following images, icons or other files as listed.


Once again, thank you so much for purchasing Freelance Cockpit. As I said at the beginning, I'd be glad to help you if you have any questions relating to this theme. No guarantees, but I'll do my best to assist. 

Luxsys