Installation & Requirements

This guide covers getting Wyregraf onto your site and confirming it is healthy. Once
it's installed, Getting Started with Wyregraf walks you through
connecting a provider and creating your first chat.

Requirements #

Wyregraf runs on a standard modern WordPress host:

• WordPress 6.2 or newer.
• PHP 8.2 or newer.
• MySQL 8.0+ or MariaDB 10.4+. The vector index is stored in your own database —
  no external vector service is required.
• An API key from an AI provider you choose (OpenAI for embeddings and/or chat,
  Anthropic for chat). You bring your own key, so usage is billed directly by the
  provider at their rates — there is no per-message markup from Wyregraf.

If your host runs an older PHP version, ask them to switch you to PHP 8.2+ before
installing.

Installing the plugin #

1. Download the Wyregraf Pro .zip from your account.
2. In WordPress, go to Plugins → Add New → Upload Plugin, choose the file, and click
   Install Now.
3. Click Activate.
4. Add your license key under Wyregraf → Options → Licenses so you receive updates.
   See How do I add my license key? The plugin works without a
   license — an inactive license only stops automatic updates, it never disables the
   chat or locks your indexed content.

On activation Wyregraf creates the database tables it needs for the vector index,
conversations, and usage accounting. This happens automatically.

Confirming everything is healthy #

Wyregraf ships a Diagnostics tab that answers "is my setup working?" at a glance. Go
to Wyregraf → Options → Diagnostics. It reports:

• Environment — your PHP and database versions.
• Database — whether all of Wyregraf's tables and the vector SQL functions installed
  correctly.
• Vector store — how many content chunks are indexed, against the practical size
  ceiling.
• Embeddings queue — whether background indexing is running, idle, or stuck.
• Provider key checks — each saved profile, with a Test connection button that
  makes a live call to confirm the key is valid.

If a row shows red, it points at exactly what to fix. The Copy report button copies a
plain-text summary (with API keys masked) you can paste into a support request.

Uninstalling #

Deactivating Wyregraf leaves your data in place so nothing is lost if you reactivate. If
you want a full removal — dropping every Wyregraf table and option — define
WYREGRAF_REMOVE_ALL_DATA as true before deleting the plugin. Without that constant,
deleting the plugin leaves your indexed content and settings untouched.