Task guides
Task guides
Choose a task, follow the steps, and use the matching CLI or SDK reference when you need more detail.
Choose the outcome you need. New installations start with the quickstart; production teams should also complete the production checklist.
Deploy
| Task | Guide |
|---|---|
| Deploy a repository | GitHub or Git URL and templates |
| Deploy files from your machine | Local folders |
| Deploy code generated by an application | Generated code and source files |
| Run an app and its supporting services | Compose and multiple services |
| Deploy branches separately | Preview environments |
| Deploy on push | Automatic deployments |
| Return to an earlier release | Rollback and redeploy |
Configure
| Task | Guide |
|---|---|
| Declare configuration in your repository | openship.json |
| Set environment variables and secrets | Environment variables |
| Restrict access to a route | Route password protection |
| Return a fixed response at the edge | Static response routes |
| Publish through an outbound tunnel | Cloudflare Tunnel |
| Add a hostname and HTTPS | Custom domains |
| Keep data across deployments | Persistent and object storage |
| Set CPU, memory, and sleep behavior | Resources and sleep |
| Clone private repositories | Git authentication |
| Register a GitHub App | Self-hosted GitHub Apps |
Operate
| Task | Guide |
|---|---|
| Inspect traffic, logs, and health | Logs and monitoring |
| Prepare a production release | Production readiness |
| Run execution workflows | Actions |
| Scale supported cluster workloads | Clusters and scaling |
| Schedule commands | Jobs |
| Protect and restore data | Backups and restores |
| Connect an SSH server | Custom servers |
| Manage the reverse proxy | The edge |
| Maintain the self-hosted control plane | Service lifecycle and headless installs |
| Update OpenShip | Updates |
| Manage access | Teams and members |
| Run mail and webmail | |
| Choose managed capacity | Cloud spaces |
| Manage Cloud charges | Billing |
Move
| Task | Guide |
|---|---|
| Import from Railway or Vercel | Platform connections and migration |
| Import from another Docker platform | Coolify, Dokploy, and Dokku |
| Move between servers | Server-to-server migration |
| Move Openship's own data | Control-plane migration |
| Connect or move to Cloud | Cloud connection and migration |
| Run application schema changes | Database migrations |
Extend
Build a catalog app, integrate the SDK, call the HTTP API, or connect an MCP client.