# mittwald developer documentation
> Complete reference documentation for the mittwald hosting platform.
This document provides a complete reference for the mittwald hosting platform.
It is optimized for AI assistants and LLMs.
This documentation covers:
- Documentation and guides on the hosting platform itself
- Specific deployment guides for various programming languages and frameworks
- Instructions on how to integrate the mittwald platform into various agentic AI systems
- Reference documentation for the mittwald LLM hosting platform (in `llms-aihosting.txt`)
- Reference documentation for the mittwald API (in `llms-api.txt`)
- Reference documentation for the mittwald CLI (in `llms-cli.txt`)
## Table of Contents
- [Managing and deploying containerized applications](https://developer.mittwald.de/docs/v2/platform/workloads/containers.md): Managing and deploying containerized applications
- [Managing and deploying Node.js applications](https://developer.mittwald.de/docs/v2/platform/workloads/nodejs.md): Learn how to deploy and manage Node.js applications.
- [Managing and deploying PHP workers](https://developer.mittwald.de/docs/v2/platform/workloads/php-worker.md): Learn how to deploy and manage PHP workers and PHP applications with embedded webservers.
- [Managing and deploying PHP applications](https://developer.mittwald.de/docs/v2/platform/workloads/php.md): Learn how to deploy and manage PHP applications.
- [Managing and deploying Python applications](https://developer.mittwald.de/docs/v2/platform/workloads/python.md): Learn how to deploy and manage Python applications.
- [Adding a caching proxy](https://developer.mittwald.de/docs/v2/platform/workloads/varnish.md): Add a caching proxy to your application or your container
- [Running webservers](https://developer.mittwald.de/docs/v2/platform/workloads/webservers.md): How to start and operate your own webserver
- [MariaDB](https://developer.mittwald.de/docs/v2/platform/databases/mariadb.md): MariaDB is a free, open-source relational database management system. Start and operate a MariaDB database containerized in your project.
- [MySQL](https://developer.mittwald.de/docs/v2/platform/databases/mysql.md): MySQL is an open-source relational database management system (RDBMS). It is a popular choice for web applications and is often used in combination...
- [OpenSearch](https://developer.mittwald.de/docs/v2/platform/databases/opensearch.md): OpenSearch is a community-driven and open-source search engine forked from Elasticsearch.
- [PostgreSQL](https://developer.mittwald.de/docs/v2/platform/databases/postgresql.md): PostgreSQL is a powerful, open-source object-relational database system. Start and operate a PostgreSQL database containerized in your project.
- [Redis](https://developer.mittwald.de/docs/v2/platform/databases/redis.md): For an e-commerce website, good performance is a real competitive advantage. To further minimize your load times, you can use Redis in all Space se...
- [Solr](https://developer.mittwald.de/docs/v2/platform/databases/solr.md): Apache Solr is a powerful, open-source search platform built on Apache Lucene.
- [Usage in coding agents](https://developer.mittwald.de/docs/v2/api/agentic-coding.md): Learn how to effectively use the mStudio v2 API in coding agents like GitHub Copilot or Claude Code. This page provides guidance on how to prompt t...
- [Change the version of a system software via the mStudio API](https://developer.mittwald.de/docs/v2/api/howtos/change-systemsoftware-version.md): Learn how to change the version of a system software (like PHP or Node.JS) via the mStudio API
- [Starting a Docker container using the API](https://developer.mittwald.de/docs/v2/api/howtos/create-container.md): Learn how to start a custom Docker container via the mStudio API
- [Creating a MySQL database using the API](https://developer.mittwald.de/docs/v2/api/howtos/create-mysql.md): This article describes how to create a MySQL database via the API
- [Installing a Node.js or Python application using the API](https://developer.mittwald.de/docs/v2/api/howtos/create-nodejs.md): Learn how to install an application that starts its own webserver (like Node.js or Python) via the mStudio API
- [Installing a PHP application using the API](https://developer.mittwald.de/docs/v2/api/howtos/create-php.md): Learn how to install a PHP application via the mStudio API
- [Creating a project using the API](https://developer.mittwald.de/docs/v2/api/howtos/create-project.md): This article describes how to create a new project using the mStudio API in various deployment scenarios.
- [Creating a Redis database using the API](https://developer.mittwald.de/docs/v2/api/howtos/create-redis.md): This article describes how to create a Redis database via the API
- [Managing DNS records over the API](https://developer.mittwald.de/docs/v2/api/howtos/manage-dns.md): This article explains how to manage different kinds of DNS records via the API
- [Managing email accounts over the API](https://developer.mittwald.de/docs/v2/api/howtos/manage-mailbox.md): This article explains different kinds of mailboxes and how to manage them via the API
- [Querying CPU and RAM usage metrics over the API](https://developer.mittwald.de/docs/v2/api/howtos/query-usage-metrics.md): This article explains how to query CPU and memory usage statistics for projects and servers via the metrics API
- [Introduction and API concepts](https://developer.mittwald.de/docs/v2/api/intro.md): This page provides an introduction to the mStudio v2 API and its concepts.
- [Generating your own API client](https://developer.mittwald.de/docs/v2/api/sdks/create-your-own.md): A guide on how to create API clients from OpenAPI specification
- [Accessing the API from Go](https://developer.mittwald.de/docs/v2/api/sdks/go.md): An overview of available Go libraries for interacting with the mittwald API.
- [Accessing the API from Javascript (Node.js or a browser)](https://developer.mittwald.de/docs/v2/api/sdks/javascript.md): An overview of available JavaScript libraries for interacting with the mittwald API.
- [Accessing the API from PHP](https://developer.mittwald.de/docs/v2/api/sdks/php.md): An overview of available PHP libraries for interacting with the mittwald API.
- [Python](https://developer.mittwald.de/docs/v2/api/sdks/python.md): Guide how to use and install the Python SDK for the mittwald API, including client generation and maintenance.
- [Password security](https://developer.mittwald.de/docs/v2/api/security/passwords.md): Various API calls enforce password policies. This document serves as a reference for different password policies enforced by the mStudio API.
- [API stability guarantees](https://developer.mittwald.de/docs/v2/api/stability.md): This page contains information about the stability guarantees of the mStudio v2 API.
- [Running Collabora](https://developer.mittwald.de/docs/v2/guides/apps/collabora.md): Learn how to set up and run Collabora Online Development Edition (CODE) with Nextcloud for collaborative document editing
- [Running Directus](https://developer.mittwald.de/docs/v2/guides/apps/directus.md): Learn how to run the open-source platform Directus in a containerized environment and connect it to a database.
- [Running Listmonk](https://developer.mittwald.de/docs/v2/guides/apps/listmonk.md): Learn how to set up and run Listmonk in a containerized environment
- [Running n8n](https://developer.mittwald.de/docs/v2/guides/apps/n8n.md): Learn how to set up an n8n container, either standalone or in conjunction with other apps
- [Running a Node.js App in a Container – Migration Guide](https://developer.mittwald.de/docs/v2/guides/apps/nodejs-container-migration.md): Step-by-step guide for migrating a mittwald mStudio Node.js app to a container
- [Running Open WebUI](https://developer.mittwald.de/docs/v2/guides/apps/openwebui.md): Learn how to set up and run Open WebUI in a containerized environment
- [Running a Shopware container](https://developer.mittwald.de/docs/v2/guides/apps/shopware.md): Learn how to build a Shopware container image, push it to a registry, and deploy it to mittwald container hosting, including the theme and plugin w...
- [Deploying AI-developed apps](https://developer.mittwald.de/docs/v2/guides/deployment/ai_developed_apps.md): Structure and quickstart for shipping AI-developed apps with a zero-conf approach
- [Deploying containerized applications with GitHub Actions](https://developer.mittwald.de/docs/v2/guides/deployment/container-actions.md): Learn how to deploy a containerized application with GitHub Actions
- [Deploying PHP applications with Deployer](https://developer.mittwald.de/docs/v2/guides/deployment/deployer.md): Deployer is a deployment tool written in PHP. It can be used to deploy PHP applications, but also other types of applications.
- [Deployment guides](https://developer.mittwald.de/docs/v2/guides/deployment.md): An overview of the available deployment strategies for the mittwald cloud platform, and guidance on which one to pick for your use case.
- [Infrastructure as code with Terraform](https://developer.mittwald.de/docs/v2/guides/deployment/terraform.md): Terraform is an open-source tool that allows you to define and provision your infrastructure using a declarative configuration language.
- [Deploying PHP applications with TYPO3 Surf](https://developer.mittwald.de/docs/v2/guides/deployment/typo3surf.md): TYPO3 Surf is a deployment tool written specifically with TYPO3 and Neos projects in mind. However, it can also be used to deploy other types of ap...
- [Excluding directories from backup](https://developer.mittwald.de/docs/v2/guides/operations/backup-exclude.md): Learn how to exclude certain directories from your backup.
- [Backing up databases running in containers](https://developer.mittwald.de/docs/v2/guides/operations/database-container-backups.md): Learn how to schedule consistent SQL dumps for PostgreSQL, MariaDB and MySQL
- [Profiling PHP applications with Tideways](https://developer.mittwald.de/docs/v2/guides/operations/tideways-profiling.md): Learn how to profile and monitor your PHP applications with Tideways, using the bundled PHP extension and a containerized Tideways daemon.
- [Authentication](https://developer.mittwald.de/docs/v2/agentic-integration/agent-skills/authentication.md): mittwald agent skills need to communicate with your mStudio account to provision resources and manage infrastructure. You can choose one or more au...
- [Agent Skills](https://developer.mittwald.de/docs/v2/agentic-integration/agent-skills.md): mittwald provides specialized agent skills that guide AI assistants through complex workflows like migrations and deployments on the mStudio platfo...
- [mittwald-migrate](https://developer.mittwald.de/docs/v2/agentic-integration/agent-skills/mittwald-migrate.md): The **mittwald-migrate** skill guides you through a conversational, phase-by-phase migration of arbitrary workloads to mittwald mStudio.
- [mittwald-zerodeploy](https://developer.mittwald.de/docs/v2/agentic-integration/agent-skills/mittwald-zerodeploy.md): The **mittwald-zerodeploy** skill provides zero-config deployment to mStudio container hosting using Railpack auto-detection. No Dockerfile needed.
- [Hermes Agent](https://developer.mittwald.de/docs/v2/agentic-integration/cli-agents/hermes-agent.md):
- [CLI Agents](https://developer.mittwald.de/docs/v2/agentic-integration/cli-agents.md):
- [opencode](https://developer.mittwald.de/docs/v2/agentic-integration/cli-agents/opencode.md):
- [Pi](https://developer.mittwald.de/docs/v2/agentic-integration/cli-agents/pi.md):
- [Cline](https://developer.mittwald.de/docs/v2/agentic-integration/ide-integration/cline.md): [Cline](https://cline.bot) is an AI coding assistant that works with Visual Studio Code, Cursor, and Windsurf.
- [Continue](https://developer.mittwald.de/docs/v2/agentic-integration/ide-integration/continue.md): [Continue](https://www.continue.dev) is an open-source AI code assistant that works with both JetBrains IDEs and Visual Studio Code.
- [IDE Integration](https://developer.mittwald.de/docs/v2/agentic-integration/ide-integration.md):
- [JetBrains AI Assistant](https://developer.mittwald.de/docs/v2/agentic-integration/ide-integration/jetbrains-ai.md): JetBrains AI Assistant supports OpenAI-compatible endpoints via Bring Your Own Key (BYOK). This works with all JetBrains IDEs including IntelliJ ID...
- [Kilo Code](https://developer.mittwald.de/docs/v2/agentic-integration/ide-integration/kilo-code.md): Kilo Code is a Visual Studio Code extension that provides AI-powered coding assistance with support for OpenAI-compatible providers.
- [Zed Editor](https://developer.mittwald.de/docs/v2/agentic-integration/ide-integration/zed.md): [Zed](https://zed.dev) is a high-performance code editor with built-in AI capabilities that supports OpenAI-compatible endpoints.
- [Agentic Integration](https://developer.mittwald.de/docs/v2/agentic-integration.md): mittwald enables **agentic integration** — connecting AI assistants to your development and operations workflows so they can do more than generate ...
- [Auth & Token Lifecycle](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/auth-token-lifecycle.md): OAuth consent, refresh, and re-authentication behavior
- [OAuth Consent and Refresh Behavior](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/auth-token-lifecycle/oauth-consent-and-refresh.md): Expected lifecycle from first consent to background token refresh
- [Re-auth Troubleshooting and Recovery](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/auth-token-lifecycle/reauth-troubleshooting.md): Diagnose repeated consent prompts and recover cleanly
- [Getting Started with ChatGPT](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/getting-connected/chatgpt.md): Install the official mittwald app in ChatGPT with step-by-step instructions
- [Getting Started with Claude Code](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/getting-connected/claude-code.md): Set up OAuth and mittwald MCP in Claude Code with step-by-step instructions
- [Getting Started with Claude](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/getting-connected/claude-desktop.md): Connect the official mittwald connector in Claude Desktop and Claude.ai with step-by-step instructions
- [Getting Connected with Codex CLI](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/getting-connected/codex-cli.md): Connect Codex CLI to mittwald MCP using OAuth or API tokens
- [Getting Started with Cursor](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/getting-connected/cursor.md): Connect mittwald MCP to Cursor using OAuth (recommended) or API token headers
- [Getting Started with GitHub Copilot](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/getting-connected/github-copilot.md): Set up OAuth and mittwald MCP in GitHub Copilot with step-by-step instructions
- [Getting Connected with Hermes Agent](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/getting-connected/hermes-agent.md): Connect Hermes Agent to mittwald MCP using OAuth or API tokens
- [Getting Connected](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/getting-connected.md): Choose your tool and set up OAuth authentication to start using mittwald MCP
- [Manage API Token Lifecycle for CI/CD](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to/api-token-lifecycle-ci.md): Create, validate, rotate, and retire mittwald API tokens used by pipelines
- [Run the Application Lifecycle](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to/application-lifecycle.md): Deploy, update, install CMS, and migrate apps with agent-led execution
- [Set Up Cronjobs and Audit Executions](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to/cronjob-setup-and-audit.md): Create scheduled tasks and verify execution health
- [Configure DNS, Forwarding, Mailbox, and SSL](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to/domain-mail-ssl.md): Complete domain and mail setup with certificate validation
- [How-To Playbooks](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to.md): Task-focused guides for common mittwald MCP operations
- [Invite and Manage Organization Members](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to/invite-and-manage-org-members.md): Add team members and audit organization access
- [Bootstrap a Project with SSH and Environment Checks](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to/project-bootstrap-ssh-environment.md): Establish baseline project readiness for deployment work
- [Set Up Redis and Manage MySQL Users](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to/redis-and-mysql-users.md): Add cache services and least-privilege database users
- [Review Account Sessions and Security](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to/session-security-review.md): Inspect account details and active sessions for suspicious activity
- [Manage Your SSH Keys](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to/ssh-key-self-management.md): Audit and update user SSH keys safely
- [Configure TYPO3 MCP via STDIO](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/how-to/typo3-mcp-stdio-setup.md): Run TYPO3 MCP through mw app exec with installation-scoped settings and known limits
- [MCP Integration](https://developer.mittwald.de/docs/v2/agentic-integration/mcp.md): Control your mittwald infrastructure through AI assistants
- [Backup Restore Incident Recovery](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/runbooks/backup-restore-incident.md): Recover service after a failed deployment using backup evidence and controlled restore
- [Runbooks](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/runbooks.md): Incident recovery procedures for mittwald MCP
- [Agency Multi-Project Management](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials/agency-multi-project-management.md): Run weekly multi-project operations review with agent execution and human approvals
- [Automated Backup Monitoring](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials/automated-backup-monitoring.md): Audit backup coverage and trigger safety backups when needed
- [CI/CD Pipeline Integration](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials/cicd-pipeline-integration.md): Connect deployment automation, cron execution checks, and safe release validation
- [Container Stack Deployment](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials/container-stack-deployment.md): Deploy and validate a Docker stack with clear verification and rollback prompts
- [Database Performance Optimization](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials/database-performance.md): Review MySQL and Redis readiness before traffic spikes
- [Developer Onboarding](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials/developer-onboarding.md): Invite team members and provision SSH/SFTP access with auditable prompts
- [E-commerce Launch Day Preparation](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials/ecommerce-launch-day.md): Run a launch-readiness check across backups, database, SSL, and app state
- [Client Onboarding Automation](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials/freelancer-client-onboarding.md): Provision project, domain, mail, and SSL from one guided prompt
- [Tutorials](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials.md): Outcome-driven human + agent walkthroughs for mittwald MCP
- [Security Audit Automation](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials/security-audit-automation.md): Build a compliance snapshot for tokens, keys, certificates, and sessions
- [TYPO3 Multi-Site Deployment](https://developer.mittwald.de/docs/v2/agentic-integration/mcp/tutorials/typo3-multisite-deployment.md): Roll out TYPO3 sites across multiple domains with controlled prompts