@scramjet/adapter-docker
v2.1.0
Published
This package is part of Scramjet Transform Hub. This module holds the docker adapters utilized by Scramjet Transform Hub
Readme
@scramjet/adapter-docker
Docker adapter for Transform Hub. Runs Sequences as Docker containers instead of direct host processes.
When to use
Use the Docker adapter when you need process isolation, environment consistency, or Docker-based deployment workflows. Each Sequence runs in its own container with configurable images for Node.js, Python, and Bun runners.
The adapter is selected via the --runtime-adapter docker flag or STH configuration. It provides:
- DockerSequenceAdapter — manages sequence storage using Docker volumes
- DockerInstanceAdapter — manages instance lifecycle as Docker containers
- Configurable runner images (
--runner-image,--runner-py-image,--runner-bun-image) - Docker networking setup for inter-container communication
Quick start
# Start STH with Docker adapter
scramjet-transform-hub --runtime-adapter dockerConfiguration
Key STH options when using the Docker adapter:
--runner-image <image>— Docker image for Node.js runner containers--runner-py-image <image>— Docker image for Python runner containers--runner-bun-image <image>— Docker image for Bun runner containers--runner-max-mem <mb>— maximum memory per runner container
Docker must be installed and the Docker daemon must be accessible from the STH process.
Stability
This package is stable.
See also
- Docker adapter deployment for detailed setup.
- Process adapter for direct process execution.
- Kubernetes adapter for Kubernetes-based deployment.
- Transform Hub configuration for adapter configuration options.
Install
npm install @scramjet/adapter-dockerImport
import { /* ... */ } from "@scramjet/adapter-docker";Documentation
See the package docs for full documentation.
