> For the complete documentation index, see [llms.txt](https://docs.qpoint.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.qpoint.io/getting-started/qplane/configuration.md).

# Configuration

Configure and manage your Qplane deployment. The cloud control plane provides centralized configuration for all connected Qtap agents across your organization.

{% hint style="info" %}
**New to Qplane?** Start with the [POC Kick Off Guide](/guides/qplane-guides/poc-kick-off-guide.md) for practical examples (10 minutes), or follow the [Getting Started](/getting-started/qplane/getting-started.md) wizard for step-by-step setup.
{% endhint %}

***

## How Qplane Configuration Works

In cloud-connected mode, your Qtap agents connect to Qplane at [app.qpoint.io](https://app.qpoint.io) to receive their configuration. Key principles:

* **Organization-wide configuration**: Stacks, plugins, routing rules, and filters apply to all installations within an organization
* **Real-time updates**: Changes propagate to connected agents within a minute
* **No restarts required**: Agents apply new configuration automatically
* **Environment identification**: Use installations to identify different environments (prod, staging, dev)

***

## Configuration Topics

### [Organizations & Environments](/getting-started/qplane/configuration/organizations-and-environments.md)

Structure your Qplane deployment using organizations, installations, and role-based access control.

**Learn how to:**

* Organize your deployment (organizations vs installations)
* Use RBAC roles to control team access
* Implement multi-environment strategies
* Choose the right access control pattern

**Best for:** Admins setting up team access and organizational structure

***

### [Stacks & Plugins](/getting-started/qplane/configuration/stacks-and-plugins.md)

Configure how Qtap processes captured traffic using stacks and plugins.

**Learn how to:**

* Create stacks for different traffic types
* Configure plugins (Report Usage, Detect Errors, Access Logs, Qscan)
* Set up domain-specific routing rules
* Use the Reliability dashboard for error detection

**Best for:** Engineers configuring traffic capture and processing

***

### [Settings](/getting-started/qplane/configuration/settings.md)

Manage global settings, storage services, filters, and agent configuration.

**Learn how to:**

* Configure traffic direction (egress-only in Qplane, ingress/all requires [local YAML](/getting-started/qtap/configuration/traffic-capture-settings.md))
* Set up object stores (S3, MinIO) for sensitive data
* Filter out noisy processes
* Manage installations and registration tokens

**Best for:** Operations teams managing infrastructure and data storage

{% hint style="info" %}
**Traffic Direction Limitations:** Qplane currently supports egress traffic only (all outbound, external-only, or internal-only). To capture ingress or bidirectional (all) traffic, you must use [local YAML configuration](/getting-started/qtap/configuration/traffic-capture-settings.md) with standalone Qtap deployment.
{% endhint %}

***

### [Alerting](/getting-started/qplane/configuration/alerting.md)

Set up real-time alerts for API performance, reliability, and security events.

**Learn how to:**

* Create alerting rules (critical latency, root user, vendor availability)
* Configure integrations (webhooks, Slack, PagerDuty)
* Filter alerts to reduce noise
* Review alert events and history

**Best for:** SREs, Secops, and on-call teams monitoring production traffic

***

### [How It Fits Together](/getting-started/qplane/configuration/how-it-fits-together.md)

Understand the complete Qpoint architecture and how all the pieces connect.

**Learn about:**

* Data flow (events vs objects vs Qscan)
* YAML configuration vs Qplane UI
* Plugin architecture and processing pipelines
* Control plane vs data plane responsibilities

**Best for:** Technical leads and architects understanding the full system

***

### [Object Storage Configuration](/getting-started/qplane/configuration/object-storage.md)

Configure S3-compatible storage for captured traffic data.

**Learn how to:**

* Set up AWS S3, MinIO, or GCS buckets
* Configure access credentials
* Manage retention policies

**Best for:** Operations teams configuring data storage

***

### [MCP Integration](/getting-started/qplane/configuration/mcp.md)

Connect AI assistants to query your traffic data via Model Context Protocol.

**Learn how to:**

* Create API keys for MCP access
* Connect Claude Code, Codex, Cursor, or other MCP clients
* Query connections, requests, issues, and PII

**Best for:** Teams using AI assistants for traffic analysis and debugging

***

## Quick Start

**1. Already have agents deployed?**

* Start with [Organizations & Environments](/getting-started/qplane/configuration/organizations-and-environments.md) to structure your deployment
* Then configure [Stacks & Plugins](/getting-started/qplane/configuration/stacks-and-plugins.md) for traffic processing

**2. Need to configure data storage?**

* Go to [Settings](/getting-started/qplane/configuration/settings.md) to set up S3-compatible object storage

**3. Want to set up monitoring?**

* Jump to [Alerting](/getting-started/qplane/configuration/alerting.md) to configure rules and integrations

**4. Understanding the system?**

* Read [How It Fits Together](/getting-started/qplane/configuration/how-it-fits-together.md) for the complete picture

***

## Common Configuration Tasks

**Configure S3 storage for sensitive data:**

1. Navigate to **Settings → Deploy → Services**
2. Add an S3-compatible object store (MinIO, AWS S3, GCS)
3. Configure access credentials
4. See [Settings](/getting-started/qplane/configuration/settings.md) for details

**Create a custom stack for specific traffic:**

1. Navigate to **Plugins → Stacks**
2. Create a new stack with desired plugins
3. Set up routing rules to assign domains to your stack
4. See [Stacks & Plugins](/getting-started/qplane/configuration/stacks-and-plugins.md) for details

**Set up team access control:**

1. Decide on your organization structure
2. Invite team members with appropriate roles
3. Create views for granular filtering (optional)
4. See [Organizations & Environments](/getting-started/qplane/configuration/organizations-and-environments.md) for details

**Configure error alerting:**

1. Navigate to **Alerting → Rules**
2. Create or enable alerting rules
3. Configure webhook/Slack integrations
4. See [Alerting](/getting-started/qplane/configuration/alerting.md) for details

***

## Related Documentation

* [Installation](/getting-started/qplane/installation.md) - Deploy additional Qtap agents
* [Getting Started](/getting-started/qplane/getting-started.md) - First-time setup walkthrough
* [Guides](/guides.md) - Step-by-step tutorials
