Servers and operations
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 where offered by that provider. Host and resource permissions still apply in native mode.
Servers
openship server list
openship server check srv_123
openship server add --host server.example.com --private-key-file /path/to/keyUse the server reference to register connections, install components, set rate limits, and monitor a server. The Servers API also exposes container, Git credential, and tunnel operations. Start with the server guide 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 |
| Choose a source, schedule, and retention | backup policy |
| Inspect executions or prepare a restore | backup run |
| Inspect, apply, or cancel a prepared restore | backup restore |
openship backup destination list
openship backup policy list --project proj_123
openship backup policy run policy_123
openship backup run list --project proj_123Preparing a restore does not apply it. Inspect the returned restore session and confirmation requirements before using the apply command. See backups and restores.
Use mail commands to provision or adopt a server, manage domains and mailboxes, and inspect delivery health. The email guide covers DNS, relay configuration, and webmail. Mail commands require an HTTP context.
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 onRenewal 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 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
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_123The 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. For moving a workload, follow server-to-server migration.
Reverse proxy
The edge workflow covers setup, domains, and traffic rules. Its complete options are in the edge reference.