WHM.AutoPilot is a complex and powerful Web Hosting and Client Management System, and so the installation process should NOT be rushed. This also applies to upgrading your installation. We have a general rule of thumb when preforming maintenance to your install. It is 'Take Your Time, And Follow Our Advice'.

Before you start installing WHM.AutoPilot, you need to check that your server is capable of running WHM.AutoPilot. Your server needs to meet the following minimum requirements:
* Windows, Linux or *BSD operating system. [ Windows servers are not *yet* fully supported ]
* PHP 4.3 or PHP5
* MySQL 4.0.22 or later
* ionCube Support ( Runtime loaders included ) OR ZEND Optimizer™

Recommended:
* Linux or *BSD operating system
* cURL Support
* ionCube Support

Note: You will need a basic understanding of PHP and HTML to integrate WHM.AutoPilot into your business or organization.

If at any time you get stuck during the installation process, please do not hesitate to contact us for assistance. You can email us at scriptsupport@whmautopilot.com and also use the support system located at https://www.WHMAutoPilot.com/support/

WHM.AutoPilot also provides an installation service where we will install WHM.AutoPilot and one order profile. This service is currently priced at $29.95 (at time of writing), and can be ordered from us by logging into your client area, selecting `Place New Order` and choose `Order Extras`. If you have more than one license, be sure to select the correct `Order ID` from the top drop down so that the installation order is added to the correct license.

[1] From within your cPanel, create a new database, database user with password and assign the user to the database for access rights. [ Example Database Username: username_dbaseuname Database Name: username_databasename ]

[2] FTP to your website. Within the `public_html` directory, create a folder named something such as `orders` and upload the contents of the `rename me` folder to this newly created directory. [ Example upload location would be: /home/username/public_html/orders ]
Reminder: Always upload files in BINARY format.

[3] Create a folder below `public_html` called `program_data` and CHMOD 777, to be used for daily backups only.[ Example program data location would be: /home/username/program_data ]

[4] Generate the admin `autopilot_configuration.php` file by visiting: http://www.yoursite.com/orders/admin/ ( or whereever the script will be installed ) to begin the installation process. You should be presented with:


Fill in the database information, click `Create Configration File Now`
=> it will prompt a download of the configuration file
=> unzip this file and upload to your admin folder

You are now ready to continue on to 1.2 Using The Web Based Installer

You are now ready to run the web based installer which will take you through the remaining steps. This is entirely web based and should only take you a few minutes to complete.

To start the installer, simply load up the `install` directory in your browser. If you have uploaded the WHM.AutoPilot administration panel files to http://www.yoursite.com/orders/admin, then the installer will be found at http://www.yoursite.com/orders/admin/install/.

The first screen you will be presented with will look something like the following:


As you can see, everything here is listed in green. If you have any red entries then you will need to look at these and resolve them before you can continue. The only exception to this is the `Checking for cURL` section. If you do not have cURL then you will be able to install WHM.AutoPilot, but you will not be able to take advantage of the cURL licensing options.

Once you are ready, click the `Click to Continue` button.

You will then be presented with the EULA screen, which will look something like this:


To proceed, read through the EULA and ensure that you understand and agree to all of the terms. If you agree, click the `I accept` button to continue installation.

If you do not agree, then you will not be able to install WHM.AutoPilot. Should you decline the EULA, you must remove all files and data from your server.

This EULA can also be found inside your client area should you need to refer to it at a later date.

The third page of the installer requires that you specify a number of paths, and will look something like this:


Default time/date format
This is the date and time display format. By default, the date format is set to m-d-Y which outputs as 03-17-2006 (mm-dd-yyyy). If you want to alter this to be `dd/mm/yyyy`, then you simply need to switch the `m` the `d`, and the `-` to read d/m/Y
For more information on formatting the date and time fields, please review the PHP.net website for the function date()

Server root path
This is the root path of your account. This can be found out by asking your web host. If you are a cPanel user, then the path will likely be: /home/username

Program Data
The program data directory is where WHM.AutoPilot stores any files that it needs, and this also contains backups of your WHM.AutoPilot installation. We again recommend keeping it outside the public root, and for cPanel users this is typically /home/username/program_data

Server Backup
This is the location where your WHM.AutoPilot backups are stored, and we recommend that this directory is placed within in the program_data folder. The defualt is in the program_data folder, but you can change the back-up location here.

HTTP Web Path
This is the location of WHM.AutoPilot as if you were accessing it from the internet. If you have WHM.AutoPilot installed at www.yoursite.com/orders/admin/, you would enter http://www.yoursite.com/orders/admin here.

HTTP Images Path
This is the location of WHM.AutoPilot images, which is a folder within the WHM.AutoPilot administration panel. If you have WHM.AutoPilot installed at www.yoursite.com/orders/admin/, you would enter http://www.yoursite.com/orders/admin/images here.
NOTE: When configuring paths, do not include the trailing slash `/`

Default e-mail address/email from/site name
These are general options that you should set according to your own preferences. These can also be changed at a later date along with any of these paths from within the WHM.AutoPilot administration panel after the installation has been completed.

License Number
This is where you need to enter your license key. It can be found by logging into the WHM.AutoPilot v3 client area, http://www.whmautopilotlicensing.com/m/client_login.php

Once you have entered all of the paths and are happy with all of the values, click the `Click to Continue` button to continue to the final page.

The final step of the installer should look something like this:


The cron job section contains a copy of the cron that you need to setup. This can usually be done within the control panel provided by your web hosts, or manually via the command line. If you are unsure, please ask your host for assistance. The cron job is an essential part of WHM.AutoPilot ( it puts AutoMation into the installation ) and is used for generating invoices, suspend account based on non-payment and taking backups of your installation. You can also find a copy of the cron job within the administration panel, and so it is not critical you set it up right now.

The admin link and password section provides the default logins that you can use to login to WHM.AutoPilot. Simply follow the link and enter the email address and password provided. If you find that the logins are not accepted, click the `Having trouble logging in? Click Here` link to reset the logins.

Finally, the last section contains an overview of the methods for contacting our support department.

Congratulations - you have now completed the web based installation of WHM.AutoPilot and the administration panel is now ready to go.

You are now ready to move on to 1.3 Logging Into The Admin Area, which contains information on logging in, and resetting your password.

Logging into the admin area requires the following:
1) A valid admin email address.
2) A valid admin password.
3) Your web browser must accept cookies for the domain installed on.
NOTE: If you have trouble logging in, or staying logged in, then try clearing the browsers cookies for the domain.

To login, or reset your password, visit your admin area http://www.yoursite.com/orders/admin/index.php
You should see something like:


Login uses an email address and password. The install process generated a secure password, however upon first access you will have to reset your password. It is recommended that you choose one you can remember and one that is secure ( A secure password would be one containing both numbers and letters ).

To reset your password, enter your admin email and click the `Click to Resend` button. You should receive an email with you new password. Upon your first login with that password, you will be prompted to change your password. Again, as above, we suggest that you choose a secure password.

Now that you've installed the admin area, and know how to login, you are now ready to install the initial profile. Reviewing 1.4 Installing An Order Profile. Before you review that heres a few quick tips.

The client area files have already been uploaded with the admin. The location is one folder below the admin area. An example location would be: http://www.example.com/orders
Reminder: Always upload files in BINARY format.

The profile will not yet work, to install an Order Profile you must first add it through the admin area.

Hover over the `Utilities` image
Click `Add New Order Profile`
You should be presented with a screen similar to:


To add your first order profile, you need to complete this form. Most of it is self explanatory, but definitions for each item can be found below.

Currency
Each order profile can have a different currency, and the currency values set here are shown on the order form next to your products pricing. The ‘Currency’ box should be used to enter the currencies abbreviation, such as USD for United States Dollars and Euro for Euro. The ‘Currency Symbol’ should be the symbol used for your currency, such as $, £, € etc…

Running PHP as CGI
If your PHP is compiled as a CGI, then you need to select ‘Yes’ from the dropdown. In most cases, this is not the case and so you can leave it set as ‘No’. Your web host will be able to tell you if PHP is running as CGI if you are unsure.

Email Group
You should choose `Order System Templates`. If you have advanced email template groups, you can choose a different one. The `Admin System Templates` should not be use for profiles.

Which terms of service to use
This is the terms of service document which users are asked to agree to during the checkout process. The dropdown contains a list of all the valid agreements added to the system, and so you should simply select the relevant one.

Profile Name
This is the name given to the order profile and it will be used throughout WHM.AutoPilot for any orders completed through the order profile.

HTTP Web Path
This is a crucial field and it must be filled in correctly. You need to enter the exact URL to your order profile, for example: http://www.example.com/orders. If you don’t get this right, you will receive an error message when attempting to use the profile.
Note: Do NOT include the trailing slash `/` at the end of the URL.

Default Site Name
This is the name of the website where the order profile is being used.

Default Time/Date Format
Much like the date is configurable for the administration panel, it can also be configured on a per order profile basis. This could be useful if you have one order profile for the USA (using mm/dd/yyyy) and another for other countries such as the UK which uses dd/mm/yyyy. The time format can also be customised to your requirements, and a number of options can be seen by clicking the link next to the field.

Base Operations Address
This is the location of your business, and is used for all invoices on the order profile. You can use HTML formatting.

Tax Types
If you have defined any tax types, then you can select which one(s) will apply to this order profile.

Pay Gateways
If you have configured multiple payment gateways, then you can configure which payment gateway to use for this order profile.

Once you have filled in all of the details, click the ‘Add Order Profile’ button to continue. You should receive a popup to acknowledge that it has been added successfully.

You will now have to generate the profiles `autopilot_configuration.php` file. This is a different file from the admin configuration file, and should be initially generated from the Profile admin area.

Hover over the ‘Utilities’ tab and click ‘Order Profiles’. Select the ‘Edit or delete an existing order profile’ option, and you should then find yourself presented with a list of available order profiles, similar to this:


To download your order profiles configuration file, simply click the ‘Download Config File’ button. You should then be prompted with a popup confirming your action, and then you should be asked to download and save the archive. Once you’ve downloaded it, unzip the archive and you should be left with a ‘autopilot_configuration.php’ file.

The next step is to navigate to your order profile via FTP and then upload this file to the root of the order profile ( its the same location you initially uploaded the client files to ). Once you’ve uploaded your configuration file, browse to the order profile and you should then find a blank page with an empty navigation bar. If this is the case, you’ve successfully installed the order profile.

Now that you’ve added the order profile, you’re ready to create your server setups, hosting packages, products, addons, coupons etc… and everything else that’s possible with WHM.AutoPilot V3.

To upgrade the database you should be logged into phpMyAdmin ( or similar database application )
Once logged in, select your v3 database.
Then click the `SQL` tab image
Then depending on the version you are upgrading from, select ONE of the queries listed below

Upgrade from to
If you are running the last release then your upgrade sql is

Upgrading from an OLDER version than to
If you are upgrading across multiple versions then click your version number to change the textarea SQL code to contain a complete SQL query to bring your installation to the latest version. This eliminates having to run multiple queries, provided you use the correct query output.

Your Current Version:

Select

Select your version to obtain a single query code to upgrade your database.

As this is the CORE of the system, we always recommend a FULL file upload and overwrite for all releases.

Upgrades do NOT require the following directories to be uploaded:
`script/admin/install` and `script/admin/upgrade`

You should upload the files to the same location you initially installed the script to. Example: /home/username/public_html/orders/admin/

Reminder: Always upload files in BINARY format.

At the current time, as with all fixes and changes being implented to the system, we are requesting FULL file upload and overwrite for all releases.

After much of the development gets finished up we will allow file-by-file upgrades, stating exactly what files have been altered, allowing you to only upload the changed, or new, files.

Multiple version upgrades will always require a FULL upload and overwrite, to ensure all files are up to date.

You should upload the files to the all your profile locations. Example: /home/username/public_html/orders/

Reminder: Always upload files in BINARY format.

Some of the common errors in the client end you may be presented with are:

Cause:	No `autopilot_configuration.php` file in the profile directory.
Solution:	Generate the profile `autopilot_configuration.php` file through your admin profile area Utilities >> Order Profiles >> Edit or delete an existing profile >> Click the Download Config File button for the profile having issues. Download the prompted file, unzip and upload it to the profile location.

Cause:	You have uploaded the admin `autopilot_configuration.php` file to the profile location.
Solution:	Generate the profile `autopilot_configuration.php` file through your admin profile area Utilities >> Order Profiles >> Edit or delete an existing profile >> Click the Download Config File button for the profile having issues. Download the prompted file, unzip and upload it to the profile location.

Cause:

You have manually edited the `autopilot_configuration.php` file, when doing so, you removed a portion of the $config['hash'] variable, the string should contain 32 characters.

Possible Solutions:

[1] Generate the profile `autopilot_configuration.php` file through your admin profile area Utilities >> Order Profiles >> Edit or delete an existing profile >> Click the Download Config File button for the profile having issues. Download the prompted file, unzip and upload it to the profile location. -- OR -- [2] Edit the profile's `autopilot_configuration.php` file. Alter the $config['hash'] variable to match whats listed in the textarea in the API Fingerprint area of your admin area. The API Fingerprint area is located at: Utilities >> API Fingerprint. Save the file changes, and upload to your profile location. If you regenerate the API Fingerprint again, you will have to re-update ALL profiles.

Cause:

You have manually edited the `autopilot_configuration.php` file, when doing so, you added some characters to the $config['hash'] variable, the string should contain 32 characters.

Possible Solutions:

[1] Generate the profile `autopilot_configuration.php` file through your admin profile area Utilities >> Order Profiles >> Edit or delete an existing profile >> Click the Download Config File button for the profile having issues. Download the prompted file, unzip and upload it to the profile location. -- OR -- [2] Edit the profile's `autopilot_configuration.php` file. Alter the $config['hash'] variable to match whats listed in the textarea in the API Fingerprint area of your admin area. The API Fingerprint area is located at: Utilities >> API Fingerprint. Save the file changes, and upload to your profile location. If you regenerate the API Fingerprint again, you will have to re-update ALL profiles.

Cause:

You have recently regenerated the API Fingerprint. This has reset the API Fingerprint, and nulled all profiles using the old key. This happens in just the same way as you WHM Remote Access key, if you regenerate that, you will have to update any connections using the old key.

Possible Solutions:

[1] Generate the profile `autopilot_configuration.php` file through your admin profile area Utilities >> Order Profiles >> Edit or delete an existing profile >> Click the Download Config File button for the profile having issues. Download the prompted file, unzip and upload it to the profile location. -- OR -- [2] Edit the profile's `autopilot_configuration.php` file. Alter the $config['hash'] variable to match whats listed in the textarea in the API Fingerprint area of your admin area. The API Fingerprint area is located at: Utilities >> API Fingerprint. Save the file changes, and upload to your profile location. If you regenerate the API Fingerprint again, you will have to re-update ALL profiles.

Causes:	There are a few reasons this may occur, for the most part, it is when MySQL is down, or has too many connections. This can also occur for profiles accessed via a secondary IP ( other than `localhost` ) if the MySQL access permissions are not set-up correctly, or even a firewall blocking the connection.
Solution:	Usually waiting a few minutes or restarting the MySQL service will resolve the error. However if you are still experiencing the error, after restarting services, checking access permissions, and firewalls then do not hesitate to contact support, so a developer can continue to debug the issue.

Causes:

You have recently moved the profile URL, or the file location does not match whats listed ( & locked in ) for the profile.

Solution:

Re-issue the profile location, from the profile management area. Utilities >> Order Profiles >> Edit or delete an existing profile >> Click the Manage button for the profile having issues. Be sure the HTTP Web Path field matches the URL the profile files are located on. Scroll down to the bottom and check the box for Click and update form to reissue this profile location. and click the Edit Order Profile button to set the changes, which re-issues the profile location.