---
url: /start/installing.md
description: >-
  What every Relyweb WHMCS module and AcelleMail plugin has in common — ionCube,
  licensing, and the four installation shapes.
---

# Installing a Relyweb app

Your app's own **Installation** page is authoritative. This page covers what they
all share.

## Before you begin

1. **The release ZIP**, from your client area at [relyweb.co](https://www.relyweb.co/).
2. **A licence key**, issued on purchase. See [Licensing & updates](/start/licensing).
3. **ionCube Loader** on the server. Every Relyweb app ships ionCube-encoded and
   will not run without it.

## ionCube Loader

Check with:

```bash
php -m | grep -i ioncube
```

or look for an **ionCube** section in `phpinfo()`. On WHMCS,
**Utilities → System → PHP Info**; on AcelleMail, **Admin → Info**.

The Loader must match your PHP version:

| PHP | Minimum Loader |
| --- | --- |
| 8.2 | 13.0.2 |
| 8.3 | 14.4.0 |
| 8.4 | 14.4.0 |

WHMCS's own minimum Loader requirements already meet these, so a correctly
configured WHMCS host needs nothing extra. If it is missing, ask your host — it
is not something you can install from inside WHMCS or AcelleMail.

## Four installation shapes

* **WHMCS add-on module:** upload into `modules/addons/`, activate under **Setup → Addon Modules**, then enter the license key in the module settings.
* **WHMCS payment gateway:** copy `modules/` into your WHMCS root, then activate under **Setup → Payment Gateways**. Enter license key and provider credentials in the gateway configuration form.
* **AcelleMail plugin:** upload under **Admin → Plugins → Upload Plugin**, activate, then enter the license key in **Settings**.
* **AcelleMail payment gateway:** installed as a plugin; the gateway becomes available once the license validates.

## After installing

**Enter the licence key first.** Most apps keep their functionality inactive
until the licence validates, so an app that looks like it did nothing is usually
an app waiting for a key.

Then work through the app's Configuration page, and check its Settings reference
for everything else.

## Upgrading an existing install

Prefer the app's own updater where it has one — it backs up files and database
first and restores them automatically on failure. Replacing files by hand skips
that safety net.