From 58dd1fd5b575731fcf7c50584512c733abe9124a Mon Sep 17 00:00:00 2001 From: Lasim Date: Wed, 3 Sep 2025 11:04:37 +0200 Subject: [PATCH 1/3] docs: update Gateway documentation to reflect support for Streamable HTTP transport and enhance session management details --- docs/development/gateway/index.mdx | 31 ++++---- .../gateway/session-management.mdx | 77 +++++++++++++++---- 2 files changed, 77 insertions(+), 31 deletions(-) diff --git a/docs/development/gateway/index.mdx b/docs/development/gateway/index.mdx index a548047..047ea12 100644 --- a/docs/development/gateway/index.mdx +++ b/docs/development/gateway/index.mdx @@ -14,21 +14,22 @@ The DeployStack Gateway is the local secure proxy that connects developers to th ## Architecture Overview -The Gateway implements a sophisticated Control Plane / Data Plane architecture with dual transport support: +The Gateway implements a sophisticated Control Plane / Data Plane architecture with comprehensive transport support: - **Control Plane**: Authenticates with `cloud.deploystack.io` to download team configurations and access policies -- **Data Plane**: Manages local MCP server processes with both stdio and SSE transport protocols +- **Data Plane**: Manages local MCP server processes with stdio, SSE, and Streamable HTTP transport protocols - **Security Layer**: Injects credentials securely into process environments without exposing them to developers - **Session Management**: Handles secure SSE connections with cryptographic session IDs for VS Code compatibility +- **Transport Layer**: Supports both legacy SSE transport and modern Streamable HTTP transport for maximum client compatibility ## Core Features } - title="Dual Transport Support" + title="Triple Transport Support" > - Supports both stdio transport for CLI tools and SSE transport for VS Code compatibility + Supports stdio transport for CLI tools, SSE transport for VS Code compatibility, and Streamable HTTP for modern MCP clients Date: Fri, 5 Sep 2025 10:12:16 +0200 Subject: [PATCH 2/3] docs: add selective restart capability to Gateway documentation --- .../gateway/process-management.mdx | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/development/gateway/process-management.mdx b/docs/development/gateway/process-management.mdx index 4c49410..37991f9 100644 --- a/docs/development/gateway/process-management.mdx +++ b/docs/development/gateway/process-management.mdx @@ -62,6 +62,31 @@ The Gateway's process management system operates on a **persistent background pr +## Selective Restart Capability + +The Gateway supports **selective restart** functionality, allowing individual MCP servers to be managed without requiring a full gateway restart. This feature dramatically improves configuration update performance and eliminates downtime for unchanged servers. + +### Key Features + +- **Individual Server Control**: Add, remove, or restart specific MCP servers via HTTP API +- **Change Detection**: Automatically detects added, removed, and modified server configurations +- **Fallback Safety**: Falls back to full restart if selective operations fail +- **Zero Downtime**: Unchanged servers continue running during configuration updates + +### API Endpoints + +The Gateway exposes HTTP endpoints for selective server management: + +- `POST /api/mcp/servers` - Add new MCP servers to running gateway +- `DELETE /api/mcp/servers/:serverName` - Remove specific servers +- `POST /api/mcp/servers/:serverName/restart` - Restart individual servers + +### Implementation Services + +- **Selective Restart Service**: Handles HTTP communication with running gateway processes +- **Configuration Change Service**: Detects configuration differences and orchestrates selective operations +- **Process Manager Integration**: Provides individual server lifecycle control capabilities + ## Process Lifecycle ### Gateway Startup Phase From 5e0c563e275814cb1071f568d312815e35ccd89c Mon Sep 17 00:00:00 2001 From: Lasim Date: Fri, 5 Sep 2025 10:36:10 +0200 Subject: [PATCH 3/3] docs: update self-hosted documentation for Docker Compose setup and adjust storage requirements --- docs/index.mdx | 2 +- docs/self-hosted/docker-compose.mdx | 68 +++-------------------------- 2 files changed, 7 insertions(+), 63 deletions(-) diff --git a/docs/index.mdx b/docs/index.mdx index d46b0f1..91c9aeb 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -33,7 +33,7 @@ DeployStack is the **Enterprise Control Plane for the Model Context Protocol (MC } - href="/self-hosted" + href="/self-hosted/quick-start" title="Self-Hosted DeployStack" > Host DeployStack on your own infrastructure for complete control and security diff --git a/docs/self-hosted/docker-compose.mdx b/docs/self-hosted/docker-compose.mdx index 40ca439..920d745 100644 --- a/docs/self-hosted/docker-compose.mdx +++ b/docs/self-hosted/docker-compose.mdx @@ -26,26 +26,11 @@ This guide provides step-by-step instructions to install and configure DeploySta - **RAM**: Ensure your environment has at least 4GB of RAM. Insufficient memory can cause processes to crash. - **Docker & Docker Compose**: Make sure both are installed and up-to-date. -- **Storage**: At least 20GB of available disk space for images and persistent data. -- **Network**: Stable internet connection for pulling Docker images. +- **Storage**: At least 2GB of available disk space for images and persistent data. -## Option 1: One-line Setup +## Beggining the setup for Docker Compose -Deploy DeployStack with a single command: - -```bash -curl -sSL https://raw.githubusercontent.com/deploystackio/deploystack/main/scripts/install.sh | bash -``` - -This script will: -1. Download the docker-compose.yml file -2. Generate a secure encryption secret -3. Start all services -4. Display access information - -## Option 2: Manual Setup - -Follow these steps for a manual setup with full control. +Follow these steps for a setup with docker compsoe ### Step 1: Download Docker Compose File @@ -258,54 +243,13 @@ docker-compose logs backend docker-compose logs frontend ``` -#### Port Conflicts - -If ports 3000 or 8080 are already in use: - -```bash -# Update .env file -FRONTEND_PORT=8081 -BACKEND_PORT=3001 - -# Restart services -docker-compose down -docker-compose up -d -``` - -#### Permission Issues - -```bash -# Fix volume permissions -sudo chown -R $USER:$USER $(docker volume inspect deploystack_backend_persistent --format '{{ .Mountpoint }}') -``` - -#### Memory Issues - -```bash -# Check available memory -free -h - -# Monitor container resource usage -docker stats -``` - ### Getting Help If you encounter issues not covered here: -1. Check the [Troubleshooting](/troubleshooting) guide -2. Search existing [GitHub Issues](https://github.com/deploystackio/deploystack/issues) -3. Join our [Discord community](https://discord.gg/UjFWwByB) -4. Create a new issue with detailed logs and system information - -## Next Steps - -Once DeployStack is running: - -1. **Create your first workspace** through the web interface -2. **Configure global settings** for email and authentication -3. **Set up user roles** and team permissions -4. **Deploy your first MCP server** from the catalog +1. Search existing [GitHub Issues](https://github.com/deploystackio/deploystack/issues) +2. Join our [Discord community](https://discord.gg/42Ce3S7b3b) +3. Create a new issue with detailed logs and system information ---