VPS_createNewProjectV1
Deploy or replace Docker Compose projects on a virtual machine by providing a URL or raw YAML content. Supports GitHub repositories and custom docker-compose.yaml files for streamlined project setup.
Instructions
Deploy new project from docker-compose.yaml contents or download contents from URL.
URL can be Github repository url in format https://github.com/[user]/[repo] and it will be automatically resolved to docker-compose.yaml file in master branch. Any other URL provided must return docker-compose.yaml file contents.
If project already exists, it will be replaced.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| content | Yes | URL pointing to docker-compose.yaml file, Github repository or raw YAML content of the compose file | |
| project_name | Yes | Docker Compose project name using alphanumeric characters, dashes, and underscores only | |
| virtualMachineId | Yes | Virtual Machine ID |
Implementation Reference
- types.d.ts:1245-1266 (schema)TypeScript interface definition for the 'VPS_createNewProjectV1' tool schema, including parameters (virtualMachineId, project_name, content, optional environment) and generic response."VPS_createNewProjectV1": { params: { /** * Virtual Machine ID */ virtualMachineId: number; /** * Docker Compose project name using alphanumeric characters, dashes, and underscores only */ project_name: string; /** * URL pointing to docker-compose.yaml file, Github repository or raw YAML content of the compose file */ content: string; /** * Project environment variables */ environment?: string; }; response: any; // Response structure will depend on the API };