<WRAP center round important 60%>
**Bear in mind that this documentation is for the last released version. If you use an older version, you must refer to the README.md file inside the plugin archive.**
</WRAP>

<markdown>
# i-MSCP WHMCS plugin

Provides an API for i-MSCP customer accounts provisioning through WHMCS.

## Introduction

WHMCS is the World's Leading Web Hosting Billing & Automation Plateform. A
complete solution for web hosts, WHMCS provides everything you need to sell
Web hosting and related services with high levels of automation.

See [WHMCS](https://www.whmcs.com/) for further details.

## Requirements

- i-MSCP Serie ≥ 1.5.x
- WHMCS ≥ 6.3.1-release.1

## Installation

### i-MSCP side

1. Be sure that all requirements as stated in the requirements section are met
2. Upload the plugin through the plugin management interface
3. Install the plugin through the plugin management interface
4. Go to the admin/settings.php page and in the `Other settings` tab, enable
   external login for the clients and resellers
5. Create one or many hosting plans for use with WHMCS (for the reseller
   accounts that you want use with WHMCS)

Don't forget the step `4`, else, you won't be able to login to i-MSCP from WHMCS.

### WHMCS side

1. Upload the `imscpHosting` directory from the plugin archive into the WHMCS
   modules/servers directory
2. If needed, restart Apache2 or the PHP-FPM instance, depending on the PHP
   SAPI you're using
3. Create a new server (Setup -> Products/Services -> Server) by selecting the
   `i-MSCP Hosting` module
4. Create a new product (Setup -> Products/Services -> Products/Services) by
   selecting the newly created server

If you don't use i-MSCP default frontEnd ports (8880/8443), don't forget to set
your custom port when creating the server.

## Update

### i-MSCP side

1. Be sure that all requirements as stated in the requirements section are met
2. Backup your plugin configuration file if needed
3. Upload the plugin through the plugin management interface

### WHMCS side

1. Upload the `imscpHosting` directory from the plugin archive into the WHMCS
   server module directory
2. If needed, restart Apache2 or the PHP-FPM instance, depending on the PHP
   SAPI you're using

### Configuration parameters

#### i-MSCP Welcome email

By default, the i-MSCP feature that is responsible to send the `Welcome Email`
for the newly created accounts is disabled. Indeed, WHMCS also sends a welcome
mail for newly created accounts. However, if you prefer let i-MSCP send the
welcome email, you can re-enable the feature by setting the `imscp_welcome_msg`
configuration parameter to true in the plugin configuration file. If you do so,
you must not forget to update the plugin list through the plugin interface.

If you prefer let WHMCS sent the `Welcome Email` for the newly created i-MSCP
accounts (default), you must not forget to create a dedicated welcome email for
i-MSCP (See Setup -> Email Templates). Once done, edit the product that you have
created and in the `details` tab, select the newly created welcome email.

## License

    i-MSCP WHMCS plugin

    @author Laurent Declercq <l.declercq@nuxwin.com>
    @copyright (C) 2016-2017 Laurent Declercq <l.declercq@nuxwin.com>
    @license i-MSCP License <http://www.i-mscp.net/license-agreement.html>

See the LICENSE file inside the archive for further details.
</markdown>