@moxxy/web-plugin
v0.0.11
Published
<p align="center"> <img src="https://moxxy.ai/logo-gradient.svg" alt="moxxy" width="120" /> </p>
Readme
Runs as a Moxxy plugin, connecting to the gateway's REST API and SSE event stream. Provides a complete web interface for managing agents, monitoring events, and configuring your self-hosted Moxxy deployment.
Features
- Dashboard overview - gateway health, active agent count, recent events
- Agent management - create, configure, delete agents; start/stop runs with real-time SSE streaming
- Memory explorer - search and compact agent long-term memory
- Skills manager - install, approve, and remove agent skills
- Template gallery - create and assign agent templates
- Event stream - live SSE event viewer with type and agent filtering
- Audit log - paginated, searchable audit log browser
- Vault - manage secrets and agent access grants
- Heartbeats - configure cron and interval-based scheduled tasks
- Webhooks - view registrations and delivery history
- Channels - manage Telegram and Discord integrations with pairing
- MCP servers - add, test, and remove Model Context Protocol servers
- Provider management - browse installed LLM providers and models
Install
moxxy plugin install @moxxy/web-pluginUsage
# Start the dashboard
moxxy plugin start @moxxy/web-plugin
# Or use the interactive plugin menu
moxxy pluginThe dashboard opens at http://localhost:17900. Navigate to Settings to configure your gateway URL and API token if they aren't injected automatically.
Development
Requires Node.js 22+ and npm.
git clone <repo>
cd web-plugin
npm install
npm run devThe dev server starts on port 17900 with a proxy that forwards /v1/* requests to the gateway at localhost:3000.
Build
npm run buildProduces a production bundle in dist/.
Preview production build
npm run plugin:startServes the built dist/ directory using a zero-dependency static server.
How it works
The plugin is a single-page application built with Ripple. At runtime it ships only pre-built static assets and a lightweight Node.js file server (serve.js) - no build tools or framework dependencies are required.
When started by the Moxxy CLI, the plugin receives environment variables (MOXXY_API_URL, MOXXY_TOKEN, PORT) and serves the dashboard on the allocated port. The dashboard communicates with the gateway entirely through its public REST API and SSE event stream.
Environment variables
Set automatically when launched via moxxy plugin start:
| Variable | Description |
|---|---|
| MOXXY_API_URL | Gateway base URL (e.g. http://localhost:3000) |
| MOXXY_TOKEN | API bearer token |
| PORT | Port to serve the dashboard on |
| MOXXY_PLUGIN_NAME | Plugin package name (@moxxy/web-plugin) |
| MOXXY_PLUGIN_PORT | Allocated port (same as PORT) |
| MOXXY_HOME | Moxxy data directory (default ~/.moxxy) |
| VITE_MOXXY_API_URL | Gateway URL exposed to browser code during development |
| VITE_MOXXY_TOKEN | API token exposed to browser code during development |
Links
License
Dual-licensed under MIT or Apache 2.0 at your option.
