About this project

Openship is a deployment platform intended to connect to a GitHub repository, local project, or prebuilt artifact and run an end-to-end delivery pipeline. It detects the stack from project files, builds a Docker image or bare release, runs the resulting service, configures an OpenResty reverse proxy, and obtains Let's Encrypt certificates. GitHub webhooks can trigger push-to-deploy pipelines, with support for preview environments, staging and production workflows, rollbacks, and monorepo change detection. Configuration can remain automatic or be overridden with openship.json. The control plane can be used in several forms. A desktop application runs locally and drives remote servers over SSH or Openship Cloud without requiring a public local endpoint. A self-hosted server is installed through the openship CLI and can run as a boot service. On Linux with Docker, Compose mode provisions Postgres, Redis, the API, dashboard, and an OpenResty edge on ports 80 and 443, and can host deployed applications on the same machine. Bare mode runs a lightweight control plane on macOS, Windows, or Linux without Docker and deploys to SSH servers or Cloud. A managed Openship Cloud option is also documented. Management interfaces include desktop and web dashboards, a scriptable CLI, a JavaScript/TypeScript Ship SDK, a REST API, and an MCP endpoint for AI agents. The README states that MCP exposes only opted-in routes, rechecks permissions, and never exposes credential or token routes. Listed platform capabilities cover multiple languages and frameworks, Docker Compose deployment, databases such as Postgres, MySQL, MongoDB, and Redis, domains and wildcard SSL, CDN caching and HTTP/3, built-in SMTP mail with DKIM, SPF, and DMARC, scheduled backups and restore, live logs and metrics, autoscaling on cloud, and multi-server deployment targets. Deployment targets include any VPS, dedicated or bare-metal servers, homelabs, and Openship Cloud. Installation is available through a shell script, npm for Node.js 22 or later, raw Docker Compose using published GHCR images, and desktop release downloads. The CLI also provides setup, updates, service control, shell completion, and project initialization commands. Openship-authored code is Apache-2.0 licensed, while bundled third-party components retain their own licenses; the README specifically notes the GPL-licensed iRedMail mail engine.