---
url: /gst-manager-acellemail/installation.md
description: >-
  Install GST Manager for AcelleMail in four steps — upload the plugin, apply
  the one-time core hook points over SSH, activate it, then license and
  configure.
---

# Installation

Installing GST Manager takes four steps: upload the plugin so its files are on the server, apply a
one-time set of **core hook points** over SSH, activate the plugin, then enter your license and fill
in your company details.

The order matters. The hook-point patcher ships **inside** the plugin, so the files have to be
uploaded before you can run it — and you activate only once the hooks are in place. Before you
start, make sure your server meets the [requirements](/gst-manager-acellemail/requirements) —
especially the ionCube Loader and SSH access.

## Step 1 — Upload the plugin files

In the AcelleMail admin, go to **Admin → Plugins → Upload Plugin** and upload the release archive
(for example `relyweb-gstmanager-vX.Y.Z.zip`). AcelleMail extracts it to
`storage/app/plugins/relyweb/gstmanager/` and lists it as inactive. **Don't activate it yet** —
apply the core hook points first.

![Uploading the GST Manager plugin in AcelleMail](/gst-manager-acellemail/img/gst-installation-upload.png)
*Admin → Plugins → Upload Plugin*

## Step 2 — Apply the one-time core hook points

GST Manager needs four small extension points in your AcelleMail code — without them the plugin
activates but its GST features (the GST invoice PDF, the GSTIN field, export numbering, and adding
tax to order totals) stay silent. Apply them over SSH from your **AcelleMail Laravel root** (the
directory containing `artisan`):

```bash
./storage/app/plugins/relyweb/gstmanager/scripts/apply-core-patches.sh .
```

The script is **idempotent** (safe to re-run) and pure PHP, so you don't need python or any extra
tooling. This step is required and easy to get slightly wrong, so follow the full walkthrough — what
it changes, how to verify it, and the important note to **re-run it after every AcelleMail
upgrade** — in [Apply the core hook points](/gst-manager-acellemail/guides/apply-core-patches).

## Step 3 — Activate the plugin

Back in **Admin → Plugins**, click **Activate** on GST Manager. Activation does the setup work for
you: it runs the database migration, seeds sensible defaults (**28 config keys and 38 Indian
states**), and mirrors the plugin's default GST rate into AcelleMail's own tax settings so new
orders carry the rate from the moment they are created.

## Step 4 — License and configure

Open the **GST Manager** entry in the AcelleMail sidebar. Because the license gates the whole GST
admin surface, you enter your key **first**: go to **Plugin Settings → License**, paste your key and
activate it. Until the license is Active, the dashboard, Setup and Reports stay locked.

With the license Active, move on to **Setup** and fill in your company GSTIN, home state, tax rate,
invoice identity and bank details. The [Configuration](/gst-manager-acellemail/configuration) guide
walks through every field.

## Related pages

* [Requirements](/gst-manager-acellemail/requirements)
* [Apply the core hook points](/gst-manager-acellemail/guides/apply-core-patches)
* [Configuration](/gst-manager-acellemail/configuration)
* [Licensing](/gst-manager-acellemail/licensing)