# DeployStack - Enterprise Control Plane for MCP

## Docs

- [API Documentation Generation](https://docs.deploystack.io/development/backend/api/index.md): Complete guide to generating OpenAPI specifications, Swagger documentation, and API testing tools for DeployStack Backend development.
- [API Pagination Guide](https://docs.deploystack.io/development/backend/api/pagination.md): Complete guide to implementing pagination in DeployStack Backend APIs, including best practices, patterns, and examples.
- [API Security](https://docs.deploystack.io/development/backend/api/security.md): Essential security patterns for DeployStack Backend API development, including proper authorization hook usage and security-first development principles.
- [Server-Sent Events (SSE)](https://docs.deploystack.io/development/backend/api/sse.md): Implementing real-time server-to-client communication using Server-Sent Events in DeployStack Backend.
- [Backend Authentication System](https://docs.deploystack.io/development/backend/auth.md): Technical documentation for the DeployStack backend authentication implementation, including session management, password hashing, and authentication flows.
- [Cloud Credentials Management](https://docs.deploystack.io/development/backend/cloud-credentials.md): Comprehensive guide to implementing and managing cloud provider credentials in DeployStack backend with encryption, validation, and role-based access control.
- [Cron Job Scheduling](https://docs.deploystack.io/development/backend/cron.md): Schedule recurring background tasks using cron expressions with the DeployStack job queue system.
- [Database Management](https://docs.deploystack.io/development/backend/database/index.md): PostgreSQL database management with Drizzle ORM for DeployStack Backend development.
- [PostgreSQL Development Guide](https://docs.deploystack.io/development/backend/database/postgresql.md): Technical implementation details and development patterns for PostgreSQL integration in DeployStack Backend.
- [Environment Variables](https://docs.deploystack.io/development/backend/environment-variables.md): Complete guide to configuring and using environment variables in the DeployStack backend application for both development and production environments.
- [Global Event Bus](https://docs.deploystack.io/development/backend/events.md): Type-safe event system for decoupled communication between core systems and plugins in DeployStack.
- [Global Settings Management](https://docs.deploystack.io/development/backend/global-settings.md): Comprehensive key-value store system with group organization, encryption support, and auto-initialization for DeployStack Backend configuration management.
- [HTML Sanitization](https://docs.deploystack.io/development/backend/html-sanitization.md): Comprehensive guide to HTML sanitization in DeployStack Backend, covering XSS prevention, input sanitization, and safe content rendering.
- [Backend Development](https://docs.deploystack.io/development/backend/index.md): Complete guide to developing and contributing to the DeployStack backend - a high-performance Node.js application built with Fastify, TypeScript, and extensible plugin architecture.
- [Background Job Queue](https://docs.deploystack.io/development/backend/job-queue.md): Database-backed job processing system with persistent storage, automatic retries, and rate limiting for long-running background tasks in DeployStack.
- [Backend Logging & Log Level Configuration](https://docs.deploystack.io/development/backend/logging.md): Complete guide to configuring and using log levels in the DeployStack backend for development and production environments.
- [Email Integration Documentation](https://docs.deploystack.io/development/backend/mail.md): Complete email system with Nodemailer, Pug templates, SMTP configuration, background job integration, and type-safe helper methods for DeployStack Backend.
- [MCP Server OAuth Implementation](https://docs.deploystack.io/development/backend/mcp-server-oauth.md): Developer guide for implementing OAuth 2.1 authentication with external MCP servers (Notion, Box, Linear, GitHub Copilot)
- [MCP Server Security](https://docs.deploystack.io/development/backend/mcp-server-security.md): Input validation and security measures for MCP server configuration in DeployStack Backend, preventing command injection, argument manipulation, and other security threats.
- [Time-Series Metrics System](https://docs.deploystack.io/development/backend/metrics.md): Developer guide for adding new time-series metrics to DeployStack using the generic metrics infrastructure.
- [OAuth2 Provider Implementation](https://docs.deploystack.io/development/backend/oauth-providers.md): Developer guide for implementing third-party OAuth2 providers (GitHub, Google, etc.) for user authentication in DeployStack
- [OAuth2 Server Implementation](https://docs.deploystack.io/development/backend/oauth2-server.md): Developer guide for the OAuth2 authorization server that enables programmatic API access via Bearer tokens
- [DeployStack Plugin System](https://docs.deploystack.io/development/backend/plugins.md): Comprehensive guide to creating extensible plugins with database tables, isolated API routes, and security features for DeployStack Backend development.
- [Role Management System](https://docs.deploystack.io/development/backend/roles.md): Developer guide for managing roles and permissions in DeployStack Backend.
- [Satellite Commands](https://docs.deploystack.io/development/backend/satellite/commands.md): Command queue system for satellite orchestration including command types, priorities, and event payload patterns.
- [Satellite Communication](https://docs.deploystack.io/development/backend/satellite/communication.md): Backend API endpoints for satellite registration, command orchestration, and configuration management with team-aware MCP server distribution.
- [Satellite Events System](https://docs.deploystack.io/development/backend/satellite/events.md): Real-time event processing from satellites to backend with convention-based handler architecture and business logic routing.
- [Security Policy](https://docs.deploystack.io/development/backend/security.md): Comprehensive security guidelines covering password hashing, session management, encryption, and vulnerability reporting for DeployStack Backend.
- [Team MCP Server Limits](https://docs.deploystack.io/development/backend/team-mcp-limits.md): Technical guide to understanding and implementing team-level MCP server installation limits in DeployStack Backend.
- [Backend End-to-End Testing](https://docs.deploystack.io/development/backend/test.md): Complete E2E testing setup with Jest, Supertest, and automated database cleanup for DeployStack Backend development.
- [User Preferences System](https://docs.deploystack.io/development/backend/user-preferences-system.md): Developer guide for managing user preferences in DeployStack Backend - adding new preferences, using the service layer, and understanding the architecture.
- [Using Server-Sent Events (SSE)](https://docs.deploystack.io/development/frontend/api-sse.md): How to consume real-time SSE endpoints from the backend using the useSSE composable
- [Frontend Architecture](https://docs.deploystack.io/development/frontend/architecture.md): Comprehensive guide to DeployStack frontend application architecture, design patterns, and development principles
- [Environment Variables](https://docs.deploystack.io/development/frontend/environment-variables.md): Complete guide to configuring and using environment variables in the DeployStack frontend application for both development and production environments.
- [Global Event Bus](https://docs.deploystack.io/development/frontend/event-bus.md): Complete guide to using the global event bus system for cross-component communication in the DeployStack frontend.
- [Global Settings Frontend Integration](https://docs.deploystack.io/development/frontend/global-settings.md): Complete guide to the flexible global settings component system for creating custom setting interfaces with connection testing and validation.
- [Frontend Development Guide](https://docs.deploystack.io/development/frontend/index.md): Complete guide to developing and contributing to the DeployStack frontend application built with Vue 3, TypeScript, and Vite.
- [Internationalization (i18n)](https://docs.deploystack.io/development/frontend/internationalization.md): Quick reference for working with i18n in DeployStack frontend
- [Plugin System](https://docs.deploystack.io/development/frontend/plugins.md): Complete guide to the DeployStack frontend plugin architecture for extending functionality with custom components, routes, and state management.
- [Router Optimization & Authentication Caching](https://docs.deploystack.io/development/frontend/router-optimization.md): Complete guide to the router performance optimizations and smart authentication caching system implemented in DeployStack frontend.
- [Frontend Storage System](https://docs.deploystack.io/development/frontend/storage.md): Complete guide to using the enhanced event bus storage system for persistent data management in the DeployStack frontend.
- [Team Context Management](https://docs.deploystack.io/development/frontend/team-context.md): Complete guide to using the useTeamContext composable for team-based access control and state management in the DeployStack frontend.
- [Custom UI Components](https://docs.deploystack.io/development/frontend/ui/custom-ui-components.md): Complete guide for creating, managing, and extending custom UI components in the DeployStack frontend, including best practices for integrating with shadcn/vue.
- [Button with Loading States](https://docs.deploystack.io/development/frontend/ui/design-button-loading.md): Guide for implementing loading states in buttons using the Spinner component.
- [Card (DsCard)](https://docs.deploystack.io/development/frontend/ui/design-card.md): Vercel-style card component with title, description, content area, and flexible footer.
- [Charts with Vue ECharts](https://docs.deploystack.io/development/frontend/ui/design-charts.md): Guide to using Apache ECharts for data visualization in DeployStack frontend
- [Meter Component](https://docs.deploystack.io/development/frontend/ui/design-ds-meter.md): Guide for implementing graphical displays of numeric values within a range using the DsMeter component.
- [Global Sonner Toast System](https://docs.deploystack.io/development/frontend/ui/design-global-sonner.md): Developer guide for using the global Sonner toast notification system in the DeployStack frontend.
- [Top Navigation Bar](https://docs.deploystack.io/development/frontend/ui/design-navbar.md): Guide for implementing the two-row top navigation bar using the DsNavbar component.
- [Page Heading](https://docs.deploystack.io/development/frontend/ui/design-page-heading.md): Vercel-style page heading component with title, optional content, and action buttons.
- [Settings Menu](https://docs.deploystack.io/development/frontend/ui/design-settings-menu.md): A composable sidebar navigation component for settings pages, following the shadcn-vue pattern.
- [Stepper](https://docs.deploystack.io/development/frontend/ui/design-stepper.md): A vertical step indicator component for multi-step wizards and forms.
- [Syntax Highlighting](https://docs.deploystack.io/development/frontend/ui/design-syntax-highlighter.md): Guide for using the CodeHighlight component to display syntax-highlighted code blocks.
- [Frontend Pagination Implementation Guide](https://docs.deploystack.io/development/frontend/ui/design-system-pagination.md): Developer guide for implementing pagination in DeployStack frontend using the PaginationControls component.
- [Structured Data Display Pattern](https://docs.deploystack.io/development/frontend/ui/design-system-structured-data.md): Mandatory design pattern for displaying structured information consistently throughout the DeployStack frontend using description lists.
- [Table Design System](https://docs.deploystack.io/development/frontend/ui/design-system-table.md): Developer guide for implementing data tables in DeployStack frontend using shadcn-vue Table components.
- [UI Design System](https://docs.deploystack.io/development/frontend/ui/index.md): Comprehensive guide to UI components, styling patterns, and design standards for the DeployStack frontend.
- [SiteHeader with Breadcrumbs](https://docs.deploystack.io/development/frontend/ui/siteHeader-with-breadcrumbs.md): Guide for implementing dynamic breadcrumb navigation in the dashboard header.
- [Satellite Architecture Design](https://docs.deploystack.io/development/satellite/architecture.md): Complete architectural overview of DeployStack Satellite - per-user MCP instance management with dual deployment support.
- [Backend Communication](https://docs.deploystack.io/development/satellite/backend-communication.md): How DeployStack Satellite communicates with the Backend from the satellite perspective - HTTP polling, command processing, and status reporting.
- [Background Jobs System](https://docs.deploystack.io/development/satellite/background-jobs.md): Cron-like job system for managing recurring background tasks in DeployStack Satellite with automatic error handling and monitoring.
- [Satellite Commands Reference](https://docs.deploystack.io/development/satellite/commands.md): Complete reference of satellite command types, priorities, and their purposes in the DeployStack satellite system.
- [Event Emission](https://docs.deploystack.io/development/satellite/event-emission.md): Events emitted by the satellite to communicate with the backend
- [Event System](https://docs.deploystack.io/development/satellite/event-system.md): Real-time event emission from satellite to backend for operational visibility, audit trails, and user feedback.
- [GitHub Deployment](https://docs.deploystack.io/development/satellite/github-deployment.md): How DeployStack Satellite handles GitHub-based MCP server deployments, including download, build, execution, and temp directory lifecycle.
- [GitHub Deployment Redeploy](https://docs.deploystack.io/development/satellite/github-deployment-redeploy.md): How DeployStack handles redeploying GitHub-based MCP servers with fresh code for all user instances.
- [Satellite Heartbeat System](https://docs.deploystack.io/development/satellite/heartbeat.md): Technical documentation for DeployStack Satellite heartbeat mechanism - periodic health monitoring, MCP status tracking, and backend integration.
- [Hierarchical Router Implementation](https://docs.deploystack.io/development/satellite/hierarchical-router.md): Technical solution to MCP context window consumption. DeployStack's hierarchical router pattern reduces token usage by 99.5% using just 4 meta-tools.
- [Idle Process Management](https://docs.deploystack.io/development/satellite/idle-process-management.md): Automatic termination and respawning of idle stdio subprocess MCP servers to optimize memory usage and resource utilization in DeployStack Satellite.
- [Satellite Development](https://docs.deploystack.io/development/satellite/index.md): Complete guide to developing and contributing to DeployStack Satellite - edge workers that manage MCP servers with team isolation and enterprise security.
- [Instance Lifecycle Management](https://docs.deploystack.io/development/satellite/instance-lifecycle.md): Per-user MCP server instance lifecycle covering creation, deletion, and team membership changes in DeployStack Satellite.
- [Instance Router (Path-Based Access)](https://docs.deploystack.io/development/satellite/instance-router.md): Direct MCP endpoint access for individual instances using token authentication. Enables standard MCP clients to connect without OAuth complexity.
- [Log Capture](https://docs.deploystack.io/development/satellite/log-capture.md): Server and request logging system in the satellite
- [Satellite Logging & Log Level Configuration](https://docs.deploystack.io/development/satellite/logging.md): Complete guide to configuring and using log levels in the DeployStack Satellite for development and production environments.
- [MCP Server Security](https://docs.deploystack.io/development/satellite/mcp-server-security.md): Defense-in-depth security validation and nsjail sandbox protection for MCP server processes in DeployStack Satellite.
- [MCP Server OAuth Token Injection](https://docs.deploystack.io/development/satellite/mcp-server-token-injection.md): How satellites retrieve and inject OAuth tokens into HTTP/SSE MCP servers for external service authentication
- [MCP Transport Protocols](https://docs.deploystack.io/development/satellite/mcp-transport.md): Official MCP SDK transport implementation for external client integration
- [OAuth Authentication Implementation](https://docs.deploystack.io/development/satellite/oauth-authentication.md): Technical implementation of multi-team OAuth 2.1 Resource Server functionality in DeployStack Satellite for MCP client authentication.
- [Backend Polling Implementation](https://docs.deploystack.io/development/satellite/polling.md): Technical implementation of satellite-to-backend polling system for command orchestration and configuration management.
- [Process Management](https://docs.deploystack.io/development/satellite/process-management.md): Technical implementation of per-user stdio subprocess management for local MCP servers in DeployStack Satellite.
- [Recovery System](https://docs.deploystack.io/development/satellite/recovery-system.md): Automatic recovery and failure handling for MCP servers
- [Satellite Registration](https://docs.deploystack.io/development/satellite/registration.md): Complete guide to DeployStack Satellite registration process - environment variables, validation rules, upsert logic, and database integration.
- [Status Tracking](https://docs.deploystack.io/development/satellite/status-tracking.md): Per-user MCP server instance status tracking system in the satellite
- [Team Isolation Implementation](https://docs.deploystack.io/development/satellite/team-isolation.md): Technical implementation of OAuth-based team and user separation in DeployStack Satellite for per-user MCP server instance access control.
- [Tool Discovery Implementation](https://docs.deploystack.io/development/satellite/tool-discovery.md): Technical implementation of MCP server tool discovery in DeployStack Satellite - unified architecture supporting both HTTP/SSE remote servers and stdio subprocess servers.
- [Architecture Overview](https://docs.deploystack.io/general/architecture.md): Complete architectural overview of DeployStack's Control Plane / Data Plane system for enterprise MCP management
- [Authentication Methods](https://docs.deploystack.io/general/auth.md): Available authentication methods in DeployStack, including email registration and GitHub OAuth, with configuration instructions for administrators.
- [GitHub Application Integration](https://docs.deploystack.io/general/github-application.md): Understanding how DeployStack's GitHub integration works for MCP server creation and repository information extraction.
- [GitHub OAuth Setup](https://docs.deploystack.io/general/github-oauth-setup.md): Configure GitHub OAuth for user authentication and single sign-on in DeployStack.
- [Global Settings](https://docs.deploystack.io/general/global-settings.md): Manage your DeployStack application settings including email configuration, authentication, and system preferences in one central location.
- [Platform Limitations](https://docs.deploystack.io/general/limitations.md): Understand when DeployStack global satellites work and when you need local MCP or team satellites instead
- [Local Development Setup](https://docs.deploystack.io/general/local-setup.md): Set up DeployStack for local development with npm scripts and hot reloading.
- [MCP Schema Creation Workflow for Global Administrators](https://docs.deploystack.io/general/mcp-admin-schema-workflow.md): Learn how global administrators transform raw MCP configurations into DeployStack's secure three-tier schema system with lock/unlock controls.
- [MCP Server Catalog](https://docs.deploystack.io/general/mcp-catalog.md): Discover, manage, and deploy Model Context Protocol (MCP) servers through DeployStack's comprehensive catalog system.
- [MCP Categories](https://docs.deploystack.io/general/mcp-categories.md): Understanding MCP server categories in DeployStack - simple organizational labels for finding the right MCP servers.
- [MCP Configuration System](https://docs.deploystack.io/general/mcp-configuration.md): Understand DeployStack's three-tier configuration architecture that manages MCP server arguments, environment variables, and credentials with granular lock/unlock controls.
- [MCP Connection Methods](https://docs.deploystack.io/general/mcp-connection-methods.md): Understanding the two ways to connect AI agents to your MCP servers - which one should you use?
- [MCP Server Installation](https://docs.deploystack.io/general/mcp-installation.md): Learn how to install and manage MCP servers within your team workspace and understand the relationship between catalog, installations, and user configurations.
- [OAuth-Enabled MCP Servers](https://docs.deploystack.io/general/mcp-oauth.md): Learn how to install and authorize OAuth-enabled MCP servers with per-user authentication and automatic token management.
- [MCP Team Installation and Configuration](https://docs.deploystack.io/general/mcp-team-installation.md): Learn how team administrators configure MCP server installations, manage shared team settings, and control user access through lock/unlock controls.
- [MCP User Configuration and Personal Settings](https://docs.deploystack.io/general/mcp-user-configuration.md): Learn how individual users configure personal MCP settings, customize their workflow, and work within team-defined boundaries.
- [Onboard New Team Members](https://docs.deploystack.io/general/onboard-new-team-members.md): Step-by-step guide to onboard new team members to your DeployStack team and MCP server environment.
- [Quick Start](https://docs.deploystack.io/general/quick-start.md): Start using MCP tools in under 1 minute with DeployStack - no installation, no configuration files, just connect and go.
- [User Roles and Permissions](https://docs.deploystack.io/general/roles.md): Understand user roles, permissions, and team management in DeployStack. Learn how to manage access control and collaborate effectively.
- [Security and Privacy](https://docs.deploystack.io/general/security.md): Learn how DeployStack protects your data, manages user accounts securely, and maintains privacy in your MCP server deployments.
- [Teams Structure in DeployStack](https://docs.deploystack.io/general/teams.md): Organize your MCP server management with teams - your workspace for managing servers and configurations in DeployStack.
- [DeployStack - MCP Management Platform](https://docs.deploystack.io/index.md): Official DeployStack documentation - MCP Management Platform with centralized credential vault, governance, and token optimization for developers and enterprises.
- [Database Setup for Self-Hosting](https://docs.deploystack.io/self-hosted/database-setup.md): Step-by-step guide to configure PostgreSQL for your self-hosted DeployStack instance.
- [Docker Compose Setup](https://docs.deploystack.io/self-hosted/docker-compose.md): Deploy DeployStack using Docker Compose for a quick and reliable self-hosted installation.
- [Production Satellite Setup](https://docs.deploystack.io/self-hosted/production-satellite.md): Deploy a production-ready DeployStack Satellite with nsjail process isolation for multi-team environments on Debian 13.
- [Quick Start](https://docs.deploystack.io/self-hosted/quick-start.md): Get DeployStack running in minutes with Docker Compose or individual Docker containers.
- [Platform Setup](https://docs.deploystack.io/self-hosted/setup.md): Configure your self-hosted DeployStack instance with global settings, email functionality, and platform features.
- [Upgrade Guide](https://docs.deploystack.io/self-hosted/upgrade-guide.md): Keep your self-hosted DeployStack instance up-to-date with the latest features and security patches.

## Optional

- [Login to DeployStack](https://cloud.deploystack.io)
- [Discord](https://discord.gg/42Ce3S7b3b)