fcakyon/claude-codex-settings / plugins/openship-skills/skills/openship-deploy
openship-deploy
VerifiedThis skill should be used when the user asks to "deploy with OpenShip", "manage a self-hosted OpenShip instance", "debug an OpenShip deployment", or manage its domains, storage, backups, or upgrades through the CLI.
| File | Kind | Size |
|---|---|---|
| LICENSE | other | 11.1 KB |
| SKILL.md | skill md | 4.0 KB |
| references/cli/access.mdx | markdown | 7.6 KB |
| references/cli/automation.mdx | markdown | 3.4 KB |
| references/cli/deploy.mdx | markdown | 4.4 KB |
| references/cli/edge.mdx | markdown | 2.0 KB |
| references/cli/index.mdx | markdown | 3.2 KB |
| references/cli/projects.mdx | markdown | 5.1 KB |
| references/cli/run.mdx | markdown | 2.6 KB |
| references/cli/self-host.mdx | markdown | 4.7 KB |
| references/guides/backups-restore.mdx | markdown | 12.9 KB |
| references/guides/custom-domains.mdx | markdown | 22.3 KB |
| references/guides/logs-monitoring.mdx | markdown | 11.8 KB |
| references/guides/migrate-control-plane.mdx | markdown | 10.4 KB |
| references/guides/persistent-storage.mdx | markdown | 7.0 KB |
| references/guides/rollback-redeploy.mdx | markdown | 16.3 KB |
| references/guides/self-hosted-github-app.mdx | markdown | 6.6 KB |
| references/guides/updating.mdx | markdown | 8.1 KB |
| references/troubleshooting/deployments.mdx | markdown | 18.0 KB |
| references/troubleshooting/domains-ssl.mdx | markdown | 16.4 KB |
| references/upstream.json | config | 7.6 KB |
references/cli/self-host.mdx
View on GitHub---
title: Servers and operations
description: Manage servers, backup workflows, mail, and instance configuration.
---
Connect to a self-hosted installation to manage its SSH servers, mail and instance settings. Project,
backup and managed-server operations also support [Cloud](https://openship.io/docs/cli/cloud) where offered by that provider.
Host and resource permissions still apply in native mode.
## Servers
```bash
openship server list
openship server check srv_123
openship server add --host server.example.com --private-key-file /path/to/key
```
Use the [server reference](https://openship.io/docs/cli/reference/server) to register connections, install components,
set rate limits, and monitor a server. The [Servers API](https://openship.io/docs/api/servers) also exposes container,
Git credential, and tunnel operations. Start with the [server guide](https://openship.io/docs/guides/custom-servers)
for prerequisites.
`--private-key-file` reads a key on the machine running the CLI and submits it through the controller's
normal credential storage. `--key-path` instead refers to a file already on the controller host.
`--password-file` reads a password without placing it in process arguments.
## Backups and restores
The workflow has four parts:
| Step | Commands |
| --- | --- |
| Configure and verify storage | [backup destination](https://openship.io/docs/cli/reference/backup/destination) |
| Choose a source, schedule, and retention | [backup policy](https://openship.io/docs/cli/reference/backup/policy) |
| Inspect executions or prepare a restore | [backup run](https://openship.io/docs/cli/reference/backup/run) |
| Inspect, apply, or cancel a prepared restore | [backup restore](https://openship.io/docs/cli/reference/backup#openship-backup-restore) |
```bash
openship backup destination list
openship backup policy list --project proj_123
openship backup policy run policy_123
openship backup run list --project proj_123
```
Preparing a restore does not apply it. Inspect the returned restore session and confirmation
requirements before using the apply command. See [backups and restores](https://openship.io/docs/guides/backups-restore).
## Mail
Use [mail commands](https://openship.io/docs/cli/reference/mail) to provision or adopt a server, manage domains and
mailboxes, and inspect delivery health. The [email guide](https://openship.io/docs/guides/email-webmail) covers DNS,
relay configuration, and webmail. Mail commands require an HTTP context.
```bash
openship mail certificate get srv_mail
openship mail certificate check srv_mail
openship mail certificate renew srv_mail
openship mail certificate auto-renew srv_mail --state on
```
Renewal and monitoring reuse the platform's edge certificate workflow. Setup reports DNS/PTR checkpoints
as pending work; an interrupted stream is not a successful installation. Use `mail status` before resuming.
## Installation settings and data
Use [system commands](https://openship.io/docs/cli/reference/system) for instance settings, onboarding, filesystem
browsing, and data transfer. Settings have native SDK support; remaining setup and migration actions
require HTTP.
Archive exports contain plaintext credentials. `system data-transfer export --out backup.json` creates
a private file and refuses to overwrite an existing file. Use `--selection selection.json` to choose
projects, history, credentials and dependencies. `system data-transfer preview --schema` describes that
input. Import accepts reviewed mappings and an explicit `--mode merge` or confirmed `--mode wipe --yes`.
Whole-instance actions require an unbound administrator credential; workspace membership alone is insufficient.
## Move or copy workloads
```bash
openship migration scan srv_source
openship migration preview --schema
openship migration preview move.json
openship migration start move.json --yes
openship migration get mig_123
openship migration events mig_123
```
The preview and start use the existing migration inputs, including exact container IDs. Inspect the
returned state and target before `migration cutover mig_123 --token-file token.txt --originals retain --yes`.
Choose `retire` only to authorize source removal. The CLI never substitutes a cutover token or repeats
an uncertain start. Use `respond` for the exact pending prompt and `resume` for reviewed path overrides
or skipped items after a partial transfer.
For moving an installation, follow [control-plane migration](https://openship.io/docs/guides/migrate-control-plane).
For moving a workload, follow [server-to-server migration](https://openship.io/docs/guides/server-to-server-migration).
## Reverse proxy
The [edge workflow](https://openship.io/docs/cli/edge) covers setup, domains, and traffic rules. Its complete options are
in the [edge reference](https://openship.io/docs/cli/reference/edge).
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |