Skip to Content
Task guides

Task guides

Choose a task, follow the steps, and use the matching CLI or SDK reference when you need more detail.

View Markdown

Choose the outcome you need. New installations start with the quickstart; production teams should also complete the production checklist.

Deploy

TaskGuide
Deploy a repositoryGitHub or Git URL and templates
Deploy files from your machineLocal folders
Deploy code generated by an applicationGenerated code and source files
Run an app and its supporting servicesCompose and multiple services
Deploy branches separatelyPreview environments
Deploy on pushAutomatic deployments
Return to an earlier releaseRollback and redeploy

Configure

TaskGuide
Declare configuration in your repositoryopenship.json
Set environment variables and secretsEnvironment variables
Restrict access to a routeRoute password protection
Return a fixed response at the edgeStatic response routes
Publish through an outbound tunnelCloudflare Tunnel
Add a hostname and HTTPSCustom domains
Keep data across deploymentsPersistent and object storage
Set CPU, memory, and sleep behaviorResources and sleep
Clone private repositoriesGit authentication
Register a GitHub AppSelf-hosted GitHub Apps

Operate

TaskGuide
Inspect traffic, logs, and healthLogs and monitoring
Prepare a production releaseProduction readiness
Run execution workflowsActions
Scale supported cluster workloadsClusters and scaling
Schedule commandsJobs
Protect and restore dataBackups and restores
Connect an SSH serverCustom servers
Manage the reverse proxyThe edge
Maintain the self-hosted control planeService lifecycle and headless installs
Update OpenShipUpdates
Manage accessTeams and members
Run mail and webmailEmail
Choose managed capacityCloud spaces
Manage Cloud chargesBilling

Move

TaskGuide
Import from Railway or VercelPlatform connections and migration
Import from another Docker platformCoolify, Dokploy, and Dokku
Move between serversServer-to-server migration
Move Openship's own dataControl-plane migration
Connect or move to CloudCloud connection and migration
Run application schema changesDatabase migrations

Extend

Build a catalog app, integrate the SDK, call the HTTP API, or connect an MCP client.

Help improve this page Edit on GitHubReport an issue

On this page