Documentation
Shipwick runs Docker applications on a single Linux server of your own: rolling deployments with health checks and rollback, HTTPS, jobs, backups, secrets and a dashboard, from one small deploy.yaml. This page says what it is, what it is not, and where to find things.
I just want to deploy
- Install the CLI on your laptop, one command
- Install on a server, one command from your laptop
- Your first deployment, from
initto a URL
You need a Linux server you can reach over SSH, a domain, and your project. shipwick init writes the Dockerfile for a Node, Next.js, Nuxt, SvelteKit, Remix, Astro, .NET, Go or Python project, and a folder of static files needs no container at all. How it fits together is the picture in one page.
I run servers for a living
- Architecture: what runs where, what is stored, how the parts talk
- Security: the trust model, tokens and sign-in, and how to expose the API
- Reference: deploy.yaml, CLI, API, Agent configuration
Every field, command, variable and endpoint is documented; every number in the reference was measured.
What Shipwick is
Shipwick is a single agent that runs on your server and turns a deploy.yaml into running, supervised containers.
# deploy.yaml
name: my-api
build: .
port: 8080
domain: api.example.com
replicas: 2shipwick deployIt is for developers and small teams running 1–20 applications on a VPS — Hetzner, DigitalOcean, OVH, EC2 or similar — who want Docker in production without writing their own deploy scripts, restart logic, health checks, rollbacks and reverse-proxy configuration.
- One binary, one SQLite file. No cluster, no control plane, no external database.
- Docker is the runtime. Anything that runs with
docker runruns on Shipwick. The image is pulled from a registry, or built on your machine byshipwick deployand sent to the server; no registry is needed for that. - A failed deployment never takes down the version that works.
The parts:
| Part | Role |
|---|---|
| Agent | Runs on the server. Owns the deployment lifecycle, supervises containers, configures Caddy. Keeps its state in SQLite. |
shipwick | The command-line client, for your laptop and for CI. Builds images with build: ., uploads static folders, and installs the server over SSH. |
| Dashboard | The same information and everyday actions in a browser. |
| Caddy | Serves application domains over HTTPS, and static sites straight from disk. The agent tells it what to route where. |
What Shipwick is not
Shipwick is for one server, by design. It schedules nothing across machines, runs no service mesh and has no extension model. The agent builds no images: with build: . the build runs on your machine, and the server only loads the result. It needs no external database or queue.
When one server is no longer enough, you have outgrown Shipwick. Until then, it is the whole platform.
Status: 1.0
The current version is 1.1.0. From 1.0 on, deploy.yaml, the API and the files on the server change only with a migration and a documented upgrade, a minor release removes and renames nothing, and a 1.x CLI works against any 1.x agent: Versions and compatibility says what that means in full, and the changelog names every change.
How the documentation is organized
Getting started
Install the CLI and the server, then deploy an application.
- How it fits together — what runs where, which parts you need, the order to set up a fresh server in, and the problems people meet on the way
- Install the CLI
- Install Shipwick on a server
- Install from a package
- Your first deployment
Concepts
How Shipwick works and why it behaves the way it does.
- Architecture
- Deployments
- Rollback
- Health checks and supervision
- Routing and HTTPS
- Resource limits and metrics
- Security
- Versions and compatibility
Tasks
How to do one specific thing.
Deploy and run
- From Docker Compose
- Coming from Dokku
- Coming from Coolify
- Deploy from CI
- Deploy from GitLab CI
- Deploy from Azure Pipelines
- Staging and production
- Scan an image before it is deployed
- Roll back and redeploy
- Get deploy.yaml back from the server
- See what is running: applications, status and logs
- Find out why it died
- Use the dashboard
- Run scheduled jobs and one-off commands
- Call one application from another
- Pull from private registries
Domains and HTTPS
- Serve several hostnames and redirect www
- Share a hostname by path and configure the proxy
- Put Cloudflare in front of the server
- Use a certificate of your own
- Expose a service that is not HTTP
Data and backups
- Run a database or other stateful application
- Back up and restore volumes
- Bring a lost server back
- Move to a new server
- Keep a second server ready
- Where your data is
Access
- Create tokens for CI and teammates
- Sign in with your company's accounts
- See who changed what
- Rotate the encryption key
- Keep the encryption key off the server's disk
Watch
The server
- Prepare a server
- Upgrade Shipwick
- Verify a release
- When things break
- Reach the API without a hostname
- Run behind a corporate proxy or without internet
- The Docker socket
Reference
Every field, command, variable and endpoint.
- deploy.yaml, and
shipwick.yamlfor several applications - shipwick
- Agent configuration
- HTTP API
Security
An admin token is equivalent to root SSH access to the server. Read Security before you put Shipwick on a machine that matters. Where your data is collects what a server stores, encrypts, logs and sends, for whoever has to answer a questionnaire about it.
Source and license
Shipwick is open source under the Apache License 2.0. The source, the issue tracker and the releases are at github.com/shipwick/shipwick.