-
-
Notifications
You must be signed in to change notification settings - Fork 0
Home
openWCS is an open-source Warehouse Control System (WCS): it orchestrates automated material-handling equipment — conveyors, ASRS (shuttles & cranes), AMRs (e.g. Geek+), and storage systems (e.g. AutoStore) — and manages the real-time flow and storage of goods inside an automated warehouse.
A WCS sits between the business-level WMS/ERP and the physical equipment: it executes and coordinates physical movement, manages real-time stock in the automated area, and lets admins design the processes (goods-in, outbound, cycle count) that run the building.
WMS / ERP ──(canonical Host API)──► openWCS ──(device adapters)──► Conveyor · ASRS · AMR · AutoStore
host orders / ASNs / master data orchestration, stock, physical movement
◄──(confirmations)── process execution
A hosted live demo is running at app.openwcs.ai — no install needed. Sign in, explore the UI, and switch on Settings → Demo mode to seed sample stock and orders.
- Getting Started — build, run the stack with Docker Compose, ports.
- Deployment Guide — install & deploy: local Linux, cloud VMs, AWS / Google Cloud / Azure containers.
- Architecture — principles, services, data ownership, event backbone.
- Services — every service, its port, and what it does.
- Host Integration — the vendor-neutral Host API any WMS/ERP integrates against.
| Area | Page |
|---|---|
| Install & deploy (local, VM, AWS/GCP/Azure) | Deployment Guide |
| Inbound (goods-in) + real-time stock | Inbound and Inventory |
| Slotting + replenishment (put-away, pick faces, ASRS/GTP) | Slotting and Replenishment |
| Outbound (orders → allocation → cubing → dispatch) | Outbound Flow |
| Equipment integration (device contract, adapters) | Equipment Integration |
| Transport overview (live device tasks, click-to-trace, scope filter) | Transport Overview |
| Host/WMS integration (orders, ASNs, confirmations) | Host Integration |
| Security (JWT, RBAC, Keycloak) | Security |
| Horizontal scaling, ShedLock, Kubernetes manifests | Horizontal Scaling |
| Service health, versions & logs (admin) | System Info |
| REST/event contracts & gateway routes | API Reference |
| Delivery roadmap & current status | Roadmap and Status |
| Conventions & how to contribute | Contributing |
| Support the project (Patreon sponsorship) | Contributing#supporting-the-project |
| License (AGPL-3.0, what operators must and need not do) | License |
The wiki summarizes; the repository docs are authoritative and updated with every change:
-
build.md— architecture & design rationale -
docs/AS-BUILT.md— what's actually implemented -
docs/DEVELOPMENT-STATUS.md— live status vs. roadmap -
docs/adr/— architecture decision records -
docs/SCALING.md— horizontal scaling guarantees (ShedLock, K8s, caveats) -
styling.md— UI design system -
public/static/roadmap.md— single source of truth for the public-facing roadmap (done / active / planned / exploring)
openWCS — open-source Warehouse Control System · summarized from build.md & docs/AS-BUILT.md (the repo docs are authoritative).