Installing Shipfox
How to run Shipfox: evaluate locally or self-host on your own infrastructure. An overview of the components and the setup paths.
Shipfox has two parts to stand up: a control plane and one or more runners. The control plane contains the API and dashboard, backed by PostgreSQL, Temporal, and S3-compatible object storage. Runners execute jobs on compute you own. This section is for whoever operates that infrastructure, typically a platform, DevEx, or SRE team.
Configuring projects and authoring workflows needs none of this. If Shipfox is already running for your team, head to Quick Start.
Components
| Component | What it is |
|---|---|
| API + dashboard | Stateless control-plane processes you deploy as containers |
| PostgreSQL | Primary datastore for Shipfox state |
| Temporal | Workflow orchestration engine used internally |
| Object storage | S3-compatible storage for step-log artifacts |
| Runners | Processes on your compute that execute jobs. See Runners. |
Choose a path
Local evaluation
Run the whole stack on your machine with Docker Compose to try Shipfox out.
Self-hosting
Understand the services, network paths, and runner choices in a self-hosted deployment.
Runner Provisioners
Understand how the Docker provisioner creates, enrolls, and assigns single-job runner instances to meet changing job demand.
Local Evaluation
Run the full Shipfox stack on your machine with Docker Compose to explore the API, dashboard, PostgreSQL, Temporal, Gitea, and object storage.