Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,16 +108,17 @@ Mintlify provides built-in components for enhanced documentation:
**Code Groups:**
```mdx
<CodeGroup>
```bash macOS/Linux
`\`\`bash macOS/Linux
npm install
```
`\`\`

```powershell Windows
`\`\`powershell Windows
npm install
```
`\`\`
</CodeGroup>
```


**Cards:**
```mdx
<CardGroup cols={2}>
Expand Down
1 change: 0 additions & 1 deletion development/backend/api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Complete guide to generating OpenAPI specifications, Swagger docume
sidebarTitle: Overview
---

# API Documentation Generation

This document explains how to generate and use the OpenAPI specification for the DeployStack Backend API.

Expand Down
1 change: 0 additions & 1 deletion development/backend/api/pagination.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: API Pagination Guide
description: Complete guide to implementing pagination in DeployStack Backend APIs, including best practices, patterns, and examples.
---

# API Pagination Guide

This document provides comprehensive guidance on implementing pagination in DeployStack Backend APIs. Pagination is essential for handling large datasets efficiently and providing a good user experience.

Expand Down
1 change: 0 additions & 1 deletion development/backend/api/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: API Security
description: Essential security patterns for DeployStack Backend API development, including proper authorization hook usage and security-first development principles.
---

# API Security

This document outlines critical security patterns and best practices for developing secure APIs in the DeployStack Backend. Following these guidelines ensures consistent security behavior and prevents common vulnerabilities.

Expand Down
1 change: 0 additions & 1 deletion development/backend/auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Backend Authentication System
description: Technical documentation for the DeployStack backend authentication implementation, including session management, password hashing, and authentication flows.
---

# Backend Authentication System

This document provides technical details about the DeployStack backend authentication system implementation. For user-facing authentication configuration, see [Authentication Methods](/auth). For OAuth provider implementation details, see [OAuth Provider Implementation](/development/backend/oauth-providers) and [OAuth2 Server Implementation](/development/backend/oauth2-server).

Expand Down
1 change: 0 additions & 1 deletion development/backend/cloud-credentials.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Cloud Credentials Management
description: Comprehensive guide to implementing and managing cloud provider credentials in DeployStack backend with encryption, validation, and role-based access control.
---

# Cloud Credentials Management

DeployStack provides a secure cloud credentials management system that allows teams to store and manage cloud provider credentials for deployments. This system features encryption, role-based access control, and provider validation.

Expand Down
1 change: 0 additions & 1 deletion development/backend/cron.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Schedule recurring background tasks using cron expressions with the
sidebarTitle: Cron
---

# Cron Job Scheduling

DeployStack includes a cron job scheduling system that integrates seamlessly with the [Background Job Queue](/development/backend/job-queue). This allows you to schedule recurring tasks using standard cron expressions, with all the benefits of the job queue system including persistence, retries, and monitoring.

Expand Down
1 change: 0 additions & 1 deletion development/backend/database/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Multi-database support with SQLite and Turso using environment-base
sidebarTitle: Overview
---

# Database Management

## Overview

Expand Down
1 change: 0 additions & 1 deletion development/backend/database/sqlite.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Technical implementation details and best practices for SQLite inte
sidebarTitle: SQLite Database
---

# SQLite Database Development Guide

## Overview

Expand Down
1 change: 0 additions & 1 deletion development/backend/database/turso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Complete guide to using Turso distributed SQLite database with Depl
sidebarTitle: Turso Database
---

# Turso Database Development

## Overview

Expand Down
1 change: 0 additions & 1 deletion development/backend/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Environment Variables
description: Complete guide to configuring and using environment variables in the DeployStack backend application for both development and production environments.
---

# Backend Environment Variables

The DeployStack backend uses Node.js environment variables that work seamlessly across development and production environments. This system supports both local `.env` files for development and Docker environment variable injection for production deployments.

Expand Down
1 change: 0 additions & 1 deletion development/backend/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Global Event Bus
description: Type-safe event system for decoupled communication between core systems and plugins in DeployStack.
---

# Global Event Bus

The Global Event Bus enables decoupled communication between core systems and plugins through a type-safe event system. Core systems emit events when important actions occur, and plugins can react without direct coupling to business logic.

Expand Down
1 change: 0 additions & 1 deletion development/backend/global-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Global Settings Management
description: Comprehensive key-value store system with group organization, encryption support, and auto-initialization for DeployStack Backend configuration management.
---

# Global Settings Management

This document describes the global key-value store system with group-based organization for managing application-wide configuration and credentials in DeployStack.

Expand Down
1 change: 0 additions & 1 deletion development/backend/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ sidebarTitle: Overview



# DeployStack Backend Development

The DeployStack backend is a modern, high-performance Node.js application built with **Fastify**, **TypeScript**, and **Drizzle ORM**. It serves as the central control plane managing MCP server catalogs, team configurations, satellite orchestration, and user authentication with enterprise-grade features.

Expand Down
3 changes: 1 addition & 2 deletions development/backend/job-queue.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Background Job Queue
description: Database-backed job processing system with persistent storage, automatic retries, and rate limiting for long-running background tasks in DeployStack.
---

# Background Job Queue System

The DeployStack backend includes a custom background job queue system for processing long-running tasks that cannot be completed within a typical HTTP request/response cycle. The system uses database-backed persistence with automatic retries and rate limiting.

Expand Down Expand Up @@ -528,4 +527,4 @@ Generate complex reports from large datasets without blocking API requests.

The background job queue system provides a simple, reliable way to process long-running tasks in DeployStack. Built on familiar SQLite/Turso infrastructure, it requires no additional services while providing persistence, retry logic, and rate limiting. Workers follow a straightforward pattern making them easy to implement and test.

For routine operations, the system handles thousands of jobs efficiently. For specialized needs requiring higher throughput or distributed processing, the architecture supports clear migration paths to more advanced solutions.
For routine operations, the system handles thousands of jobs efficiently. For specialized needs requiring higher throughput or distributed processing, the architecture supports clear migration paths to more advanced solutions.
1 change: 0 additions & 1 deletion development/backend/logging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ sidebarTitle: Logging



# Backend Log Level Configuration

The DeployStack backend uses **Pino** logger with **Fastify** for high-performance, structured logging. This guide covers everything you need to know about configuring and using log levels effectively.

Expand Down
1 change: 0 additions & 1 deletion development/backend/mail.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ description: Complete email system with Nodemailer, Pug templates, SMTP configur



# Email Integration Documentation

This document describes the email system integration in DeployStack, including the email service, template system, and recommended usage patterns.

Expand Down
1 change: 0 additions & 1 deletion development/backend/mcp-configuration-architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: MCP Configuration Architecture
description: Developer guide to DeployStack's three-tier MCP server configuration system for arguments and environment variables.
---

# MCP Configuration Architecture

DeployStack implements a sophisticated three-tier configuration architecture for managing MCP server command line arguments and environment variables. This system supports multi-user teams while maintaining clean separation between fixed template parameters, shared team settings, and individual user configurations.

Expand Down
1 change: 0 additions & 1 deletion development/backend/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Developer guide for adding new time-series metrics to DeployStack u
sidebarTitle: Metrics System
---

# Time-Series Metrics System

DeployStack includes a generic time-series metrics system for collecting and querying bucketed activity data. This guide shows you how to add new metric types (like server installations, tool executions, satellite health, etc.) following the established pattern.

Expand Down
1 change: 0 additions & 1 deletion development/backend/oauth-providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Developer guide for implementing third-party OAuth2 providers (GitH
sidebarTitle: OAuth2 Providers
---

# OAuth2 Provider Implementation

This document describes how to implement third-party OAuth2 providers for user authentication in DeployStack. The system currently supports GitHub OAuth2 as a reference implementation, but the architecture is designed to easily accommodate additional providers like Google, Microsoft, GitLab, and others.

Expand Down
3 changes: 1 addition & 2 deletions development/backend/oauth2-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Developer guide for the OAuth2 authorization server that enables pr
sidebarTitle: OAuth2 Server
---

# OAuth2 Server Implementation

This document describes the OAuth2 authorization server implementation in the DeployStack backend, which enables CLI tools and applications to access APIs using Bearer tokens. For general authentication, see [Backend Authentication System](/development/backend/auth). For OAuth provider integration (social login), see [Providers OAuth Implementation](/development/backend/oauth-providers).

Expand Down Expand Up @@ -555,4 +554,4 @@ The OAuth2 server supports MCP clients through dynamic registration:
- [Satellite OAuth Authentication](/development/satellite/oauth-authentication) - MCP client authentication
- [Security Policy](/development/backend/security) - Security details
- [API Documentation](/development/backend/api/) - API reference
- [OAuth Provider Implementation](/development/backend/oauth-providers) - Third-party OAuth login setup
- [OAuth Provider Implementation](/development/backend/oauth-providers) - Third-party OAuth login setup
1 change: 0 additions & 1 deletion development/backend/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: DeployStack Plugin System
description: Comprehensive guide to creating extensible plugins with database tables, isolated API routes, and security features for DeployStack Backend development.
---

# DeployStack Plugin System

This document explains how to create and integrate plugins into DeployStack. The plugin system enables extending DeployStack with additional functionality, cloud providers, database tables, APIs, and UI components.

Expand Down
1 change: 0 additions & 1 deletion development/backend/roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Role Management System
description: Developer guide for managing roles and permissions in DeployStack Backend.
---

# Role Management System

This guide explains how to manage roles and permissions in the DeployStack backend for developers.

Expand Down
1 change: 0 additions & 1 deletion development/backend/satellite/communication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Backend API endpoints for satellite registration, command orchestra
sidebarTitle: Communication
---

# Satellite Communication

The DeployStack backend implements satellite management APIs that handle registration, command orchestration, and configuration distribution. The system supports both global satellites (serving all teams) and team satellites (serving specific teams) through a polling-based communication architecture.

Expand Down
1 change: 0 additions & 1 deletion development/backend/satellite/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Real-time event processing from satellites to backend with conventi
sidebarTitle: Events
---

# Satellite Events System

The Satellite Events System provides real-time communication from satellites to the backend for operational visibility, audit trails, and user feedback. Events are processed through a convention-based dispatcher that routes them to handlers updating existing business tables.

Expand Down
1 change: 0 additions & 1 deletion development/backend/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Security Policy
description: Comprehensive security guidelines covering password hashing, session management, encryption, and vulnerability reporting for DeployStack Backend.
---

# Security Policy

This document outlines security procedures and policies for the backend service.

Expand Down
1 change: 0 additions & 1 deletion development/backend/test.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Complete E2E testing setup with Jest, Supertest, and automated data
sidebarTitle: Backend E2E Testing
---

# Backend End-to-End Testing

This document outlines the setup and execution of end-to-end (E2E) tests for the DeployStack backend.

Expand Down
1 change: 0 additions & 1 deletion development/backend/user-preferences-system.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: User Preferences System
description: Developer guide for managing user preferences in DeployStack Backend - adding new preferences, using the service layer, and understanding the architecture.
---

# User Preferences System

The User Preferences System provides a flexible, config-driven approach to managing user-specific settings and behavioral data in DeployStack. This system handles everything from onboarding states to UI preferences without requiring database migrations for new preferences.

Expand Down
3 changes: 1 addition & 2 deletions development/frontend/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Comprehensive guide to DeployStack frontend application architectur
sidebarTitle: Architecture
---

# Frontend Architecture

This document defines the architectural principles, patterns, and conventions that govern the DeployStack frontend application. All developers must understand and follow these guidelines to maintain consistency and quality across the codebase.

Expand Down Expand Up @@ -615,4 +614,4 @@ As the application grows, consider:

This architecture provides a scalable, maintainable foundation for the DeployStack frontend. Following these patterns ensures consistency, reduces bugs, and improves developer productivity. When in doubt, prioritize clarity and simplicity over clever solutions.

Remember: **Architecture is a team effort**. Propose improvements, discuss trade-offs, and evolve these patterns as the application grows.
Remember: **Architecture is a team effort**. Propose improvements, discuss trade-offs, and evolve these patterns as the application grows.
1 change: 0 additions & 1 deletion development/frontend/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Environment Variables
description: Complete guide to configuring and using environment variables in the DeployStack frontend application for both development and production environments.
---

# Frontend Environment Variables

The DeployStack frontend uses a sophisticated environment variable system that seamlessly works across development and production environments. This system supports both Vite's build-time variables and Docker runtime variables for maximum flexibility.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/event-bus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Global Event Bus
description: Complete guide to using the global event bus system for cross-component communication in the DeployStack frontend.
---

# Global Event Bus

The DeployStack frontend implements a global event bus system using the [mitt](https://github.com/developit/mitt) library to enable efficient cross-component communication. This system provides immediate updates across components without requiring direct parent-child relationships or complex state management.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/global-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Complete guide to the flexible global settings component system for
sidebarTitle: Global Settings
---

# Global Settings Frontend Integration

The DeployStack frontend provides a flexible component system for global settings that allows developers to create custom interfaces for specific setting groups. This system enables rich functionality like connection testing, custom validation, and specialized UI components while maintaining consistency with the overall design system.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Complete guide to developing and contributing to the DeployStack fr
sidebarTitle: Overview
---

# DeployStack Frontend Development

The DeployStack frontend is a modern web application built with Vue 3, TypeScript, and Vite, specifically designed for managing MCP (Model Context Protocol) server configurations. This guide covers everything you need to know to develop and contribute to the frontend.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/internationalization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Internationalization (i18n)
description: Quick reference for working with i18n in DeployStack frontend
---

# Internationalization (i18n)

DeployStack uses Vue I18n with a modular file structure. Translations are organized by feature for easy maintenance.

Expand Down
3 changes: 1 addition & 2 deletions development/frontend/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Plugin System
description: Complete guide to the DeployStack frontend plugin architecture for extending functionality with custom components, routes, and state management.
---

# Frontend Plugin System

DeployStack's frontend features a powerful plugin architecture that enables extending the application with additional functionality, UI components, routes, and state management. This modular approach allows for clean separation of concerns and extensible development.

Expand Down Expand Up @@ -782,4 +781,4 @@ class PerformanceMonitoredPlugin implements Plugin {
}
```

This plugin system documentation provides everything needed to create maintainable and well-tested plugins for the DeployStack frontend. The modular architecture ensures that functionality can be extended cleanly while maintaining the core application's stability and performance.
This plugin system documentation provides everything needed to create maintainable and well-tested plugins for the DeployStack frontend. The modular architecture ensures that functionality can be extended cleanly while maintaining the core application's stability and performance.
1 change: 0 additions & 1 deletion development/frontend/router-optimization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Complete guide to the router performance optimizations and smart au
sidebarTitle: Router Optimization
---

# Router Optimization & Authentication Caching

This guide documents the comprehensive optimization implemented to eliminate unnecessary API calls and improve navigation performance in the DeployStack frontend, particularly focusing on authentication flows and route-specific optimizations.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/storage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Complete guide to using the enhanced event bus storage system for p
sidebarTitle: Storage System
---

# Frontend Storage System

The storage system is built into the [global event bus](/development/frontend/event-bus) and provides persistent data management across route changes and browser sessions. This system uses localStorage with a type-safe API and automatically emits events when data changes.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/ui/custom-ui-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Custom UI Components
description: Complete guide for creating, managing, and extending custom UI components in the DeployStack frontend, including best practices for integrating with shadcn/vue.
---

# Custom UI Components

This guide covers creating and managing custom UI components in DeployStack, including extending shadcn/vue components, building new components from scratch, and maintaining consistency across your design system.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/ui/design-button-loading.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Button with Loading States
description: Guide for using the enhanced Button component with built-in loading states.
---

# Button with Loading States

The Button component includes built-in loading state functionality for async operations.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/ui/design-charts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Charts with Vue ECharts
description: Guide to using Apache ECharts for data visualization in DeployStack frontend
---

# Charts with Vue ECharts

DeployStack uses [vue-echarts](https://github.com/ecomfe/vue-echarts) for data visualization, providing powerful and performant charts with Apache ECharts integration for Vue 3.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/ui/design-global-sonner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Global Sonner Toast System
description: Developer guide for using the global Sonner toast notification system in the DeployStack frontend.
---

# Global Sonner Toast System

DeployStack uses [Sonner](https://sonner.emilkowal.ski/) for toast notifications, providing elegant and accessible notifications across the entire application. The system is globally configured and requires no additional setup in individual components.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/ui/design-syntax-highlighter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Syntax Highlighting
description: Guide for using the CodeHighlight component to display syntax-highlighted code blocks.
---

# Syntax Highlighting

The `CodeHighlight` component provides syntax highlighting for code blocks using Prism.js. It's a reusable component that handles the highlighting automatically without requiring manual Prism.js imports.

Expand Down
1 change: 0 additions & 1 deletion development/frontend/ui/design-system-pagination.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: Developer guide for implementing pagination in DeployStack frontend
sidebarTitle: Pagination Guide
---

# Frontend Pagination Implementation Guide

This guide shows developers how to add pagination to any data table in the DeployStack frontend.

Expand Down
Loading
Loading