## 3. Installation

This section describes how to install ChatAI using the standard ProcessWire module workflow.

---

### Requirements and Assumptions

Before installing ChatAI, ensure the following:

- A working ProcessWire installation.
- AgentTools is installed and available.
- A chat-capable model entry will be configured in AgentTools.
- An embeddings-capable model entry will be configured in AgentTools.

ChatAI uses standard ProcessWire configuration and installation mechanisms.  
If your environment is incompatible, you will be notified during installation.

ChatAI assumes:
- you are familiar with installing ProcessWire modules,
- you have access to the admin interface,
- and you are comfortable reviewing module configuration after install.

No frontend integration is required at install time.

---

### Installing the Module

ChatAI is installed using the standard ProcessWire module workflow.

1. Download or clone the ChatAI repository from GitHub at https://github.com/clipmagic/ChatAI
2. Place the module files into your site’s modules directory: /site/modules/ChatAI/
3. Log in to the ProcessWire admin.
4. Navigate to: Modules → Refresh
5. Locate **ChatAI** in the module list and click **Install**.

During installation, ChatAI will:
- register required database tables,
- initialise default configuration values,
- and prepare internal services.

---

### First-Time Setup Checklist

After installing the module, complete these steps in order:

1. Install prerequisites.
   Confirm AgentTools is installed and available in the ProcessWire admin.
2. Configure two AgentTools model entries.
   Create one chat-capable model entry and one embeddings-capable model entry.
3. Configure the ChatAI module.
   In **Modules > ChatAI**, select the AgentTools chat model, select the AgentTools embedding model, and review module-level settings. See [ChatAI Module Configuration](chatai-config.md).
4. Configure ProcessChatAI.
   In **Setup > ChatAI**, review Prompt, Dictionary, Personalise, RAG, and dashboard settings, then save the configuration. Blacklist filtering is enabled by default with starter terms; review those terms for the site. See [ProcessChatAI Configuration](processchatai-config.md).
5. Index the site content
   From the **Setup > ChatAI** Dashboard tab, bulk (re)index the site content to populate the RAG vector database.
6. Add frontend integration.
   Add the widget, stylesheet, and script calls to your site templates. See [Frontend Integration](frontend-integration.md).

ChatAI requires an embeddings-capable model for content indexing and contextual answers.

---

### Verifying a Successful Install

A successful installation can be confirmed by:

- ChatAI appearing in the ProcessWire admin menu.
- No errors reported during module install.
- Admin screens loading without blocking errors.
- Test requests returning responses when ChatAI is enabled.

If ChatAI is enabled but not visible on the frontend, this is expected until frontend integration is configured.

---

### Uninstalling Cleanly

ChatAI can be uninstalled via the standard ProcessWire module interface.

On uninstall:
- configuration data may be removed,
- database tables created by ChatAI may be dropped,
- and frontend integrations must be removed manually.

Uninstall behaviour is intentionally explicit to avoid accidental data loss.

If you intend to reinstall ChatAI later, review uninstall options carefully before proceeding.

---

Later sections cover admin configuration, frontend integration, and optional advanced features in more detail.