Shadowx documentation
Install, configure and operate Shadowx — and integrate with its API.
Shadowx protects sensitive data from exposure to external AI services. It inspects prompts, files and conversations against your policies, masks what it finds, and records every event for review.
How a deployment is put together#
Shadowx runs as a set of containers on a single Linux host. One command installs all of them. You can add a second host later for high availability without changing the first.
| Component | What it does |
|---|---|
| Web portal | The administrative interface, and the installer that prepares the database on first start |
| Sanitization API | Core sanitization and AI logic — the service your integrations call |
| Background worker | Scheduled work: security tasks, backups, replication, notifications |
| Shadowx Proxy | Inspects AI traffic routed through it |
| Sanitizer models | The detection models the sanitization pipeline uses |
| MCP server | Exposes Shadowx tooling to AI clients |
| Teams bot | Governed conversations inside Microsoft Teams |
| Supporting services | Database, data indices, messaging and cache |
Where configuration lives#
Almost nothing is configured in files. After installation, everything — thresholds, endpoints, prompts, integration credentials, the backup schedule — is edited in the portal under Settings → System Settings and applied with one click.
A small number of bootstrap facts have to exist before the database can be read, and those stay in the generated environment file. See Configuration.
Modules#
Your licence determines which modules are enabled. The portal, chat and DLP features, the core worker roles, backup and disaster recovery are included with any valid licence.
| Module | Unlocks |
|---|---|
| FilterX | Browser DLP (extension and browser-log processing) and the Teams bot |
| RedX | Red Team |
| VisionX | SOC Forensics |
| SOCAI | SOC Retro-Hunt and the MCP server |
See Licensing for activation and renewal.
Where to go next#
| Guide | Read it when |
|---|---|
| Installation | Setting up a new server |
| High availability | Before installing, if you intend to run two sites |
| Configuration | Changing settings day to day |
| Licensing | Activating the product or adding modules |
| TLS certificate | Installing or renewing your certificate |
| Backup & restore | Protecting and recovering data |
| Upgrading | Moving to a new release |
| Troubleshooting | Something will not start |
| API reference | Integrating with Shadowx |