Open-source, self-hostable deployment platform with built-in CI/CD.
Push code, ship containers, manage infrastructure — from a desktop app, web dashboard, or CLI.
Quick Start · Features · Interfaces · Docs · Contributing
Pick by how you work — solo → desktop app, team / always-on → CLI on a server.
The control plane runs on your machine and drives your servers over SSH; nothing of Openship is exposed publicly. Download, open, done — no terminal needed:
| Platform | Download |
|---|---|
| macOS (Apple Silicon) | Openship-arm64.dmg |
| macOS (Intel) | Openship-x64.dmg |
| Windows | Openship-win32-x64.zip |
| Linux | Openship.AppImage |
Linux: chmod +x Openship.AppImage && ./Openship.AppImage. Links always point at the newest release.
Install the CLI (it bundles the API + dashboard), then run openship — an interactive wizard creates the first admin, wires your domain, and installs itself as a boot service. Run it again anytime to manage the instance.
curl -fsSL https://get.openship.io | sh # install (or: npm i -g openship)
openship # interactive setup, then control panelFor CI / headless boxes, skip the wizard and drive openship up directly — same background service, boots and auto-restarts:
openship up # background service on this machine
openship up --public-url https://openship.example.com # + expose on your domain (edge + TLS handled)openship open opens the dashboard · openship stop stops it · openship update upgrades · openship up --foreground runs attached.
Deploy a project:
cd your-project
openship init # link this directory to a project
openship deployFull server guide + complete CLI reference: docs/installation.md.
Advanced: run from source with Docker Compose (not the recommended path)
Heavier than the CLI, and the compose stack gives the control-plane container access to the host Docker daemon (host-privileged) — use it only if you specifically need a containerized control plane. The CLI and desktop app above are the supported installs.
git clone https://github.com/oblien/openship.git && cd openship
cp .env.example .env
docker compose up -dPoint it at a repo. Openship detects your stack, builds it, configures everything, and ships it — zero config files, zero pipelines, zero YAML.
Databases, domains, SSL, CDN, mail, backups — all managed from one place.
Solo devs shipping side projects and teams running production use the same tool.
| Built-in CI/CD | Push-to-deploy, preview environments, staging/prod flows, rollbacks |
| Any stack | Node, Python, Go, Rust, PHP, Ruby, Java, .NET, Docker, monorepos |
| Full backend | Postgres, MySQL, MongoDB, Redis, workers, WebSockets, storage |
| Domains & SSL | Automatic Let's Encrypt, wildcards, unlimited domains, auto-renewal |
| CDN | Edge caching, HTTP/3, Brotli compression, instant purge |
| Mail server | Built-in SMTP with DKIM/SPF/DMARC — no Mailgun or SES needed |
| Backups | Scheduled, databases + volumes, one-click restore, export anytime |
| Real-time monitoring | Live build logs, container metrics, and resource usage streamed to your screen |
| Scaling | Auto-scaling on cloud, multi-node ready on self-hosted |
| Portability | Standard Docker containers — move between providers freely |
| Docker Compose | Deploy existing compose files as-is |
- Openship Cloud — managed, auto-scaling, zero setup
- Any VPS — Hetzner, DigitalOcean, Linode, OVH, and the rest
- Dedicated servers — bare metal, colo, homelab
- Multi-server — spread workloads across machines
Same interface regardless of where you deploy.
- Desktop app — full GUI, real-time logs, one-click everything.
- Web dashboard — the same UI in the browser, built for teams.
- CLI — scriptable and CI-friendly.
A REST API and MCP (AI agent protocol) round it out for automation and tooling integration. Full command and API reference at openship.io/docs.
Note
The docs are still a work in progress — we're actively filling them out. If something's missing or unclear, contributions are hugely welcome and help us get there faster.
Production-ready core, actively developed.
Coming next: multi-node clusters, load-balancing UI, private networking, advanced monitoring, and visual CI/CD pipelines.
See CONTRIBUTING.md.
Cut a release with the version script — it syncs every package's version,
commits the bump, tags vX.Y.Z, and pushes:
bun scripts/release.ts 0.2.0 # explicit version
# or a bump keyword: patch | minor | major | rc (minor from 0.1.x → 0.2.0)Pushing the tag triggers .github/workflows/release.yml, which:
- builds the macOS / Windows / Linux installers and the server tarballs (with SHA-256 sidecars),
- publishes the
openshipCLI to npm — via npm OIDC trusted publishing (no token), and - creates the GitHub Release with the built assets (notes come from the tag).
To flag a release as critical (or add recommended/info advisories) in the
in-app updater, add an entry to release-advisories.json
before tagging — clients pull it pinned to the release tag. High-level notes
live in CHANGELOG.md.
Found a vulnerability? We welcome your report — please disclose it privately, never in a public issue, PR, or discussion.
- Report it here (preferred): Report a vulnerability — a private GitHub advisory, visible only to you and the maintainers.
- Scope, what to include, and our response/disclosure process: SECURITY.md.
Good-faith security research is authorized under our safe-harbor policy, and we're happy to credit valid first reports.
Openship is open-source software, licensed under the Apache License 2.0.
You may use, run, modify, self-host, and distribute it — including in commercial and closed-source products — under the terms of the Apache 2.0 license. See LICENSE for the full text.
