Node.js runtime image built on UDX Worker.

Quick Start • Usage • Development • Resources

Overview

UDX Worker Node.js is a Docker image that provides a ready-to-use Node.js runtime with the same operational model as udx/worker (https://github.com/udx/worker).

Quick Start

Requirements: Docker and Node.js (for the CLI).

1. Install the deployment CLI (@udx/worker-deployment).

npm install -g @udx/worker-deployment

2. Generate a config and edit deploy.yml for your app.

worker config

3. Run the container.

worker run

Usage

• Deploy configuration: https://github.com/udx/worker-deployment/blob/latest/docs/deploy-config.md

• Service configuration: https://github.com/udx/worker/blob/latest/docs/runtime/services.md

• Runtime config and secrets: https://github.com/udx/worker/blob/latest/docs/runtime/config.md

Examples

• src/examples/simple-server is included as a minimal sample.

Development

git clone https://github.com/udx/worker-nodejs.git
cd worker-nodejs

make build
make test

To run a single test:

make run-test TEST_SCRIPT=10_validate_environment.sh

Build defaults for contributors live in Makefile.variables (Node.js version, ports, build args).

Resources

• Base image docs: https://github.com/udx/worker/tree/latest/docs
• Deployment CLI: https://github.com/udx/worker-deployment/tree/latest/docs
• Docker Hub: https://hub.docker.com/r/usabilitydynamics/udx-worker-nodejs

Contributing

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to your branch
5. Open a Pull Request

Please ensure your PR includes appropriate tests and documentation updates.

---

Built by UDX © 2025