Skip to content

Commit eba48ab

Browse files
deploy: 1750fec
1 parent b0d3c4d commit eba48ab

185 files changed

Lines changed: 1179 additions & 891 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2.0/llms-full.txt

Lines changed: 122 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,124 @@ There are several reasons why developers might choose to use Durable Workflow fo
3030

3131
Compared to the built-in queues, Durable Workflow allows for more complex and dynamic control over the execution of jobs, such as branching and looping, and provides a way to monitor the progress and status of the workflow as a whole. Unlike job chaining and batching, which are designed to execute a fixed set of jobs in a predetermined sequence, Durable Workflow also allows for more flexible and adaptable execution.
3232

33+
# Getting Started
34+
35+
Durable Workflow 2.0 is currently published as preview documentation. Use the
36+
version picker for the stable 1.x docs; use this page when you want to try the
37+
2.0 engine, standalone server, CLI, or Python SDK.
38+
39+
## Install Commands
40+
41+
| Surface | Command |
42+
| --- | --- |
43+
| Laravel package | `composer require durable-workflow/workflow:^2.0@alpha` |
44+
| Standalone server image | `docker pull durableworkflow/server:0.2.2` |
45+
| CLI | `curl -fsSL https://durable-workflow.com/install.sh \| sh` |
46+
| Python SDK | `pip install durable-workflow` |
47+
48+
## Choose Your Path
49+
50+
### I am a Laravel user
51+
52+
The fastest Laravel path is the maintained sample application. It installs the
53+
package, runs migrations, starts a queue worker, and executes a real workflow.
54+
55+
```bash
56+
git clone https://github.com/durable-workflow/sample-app.git
57+
cd sample-app
58+
composer install
59+
php artisan app:init
60+
```
61+
62+
Keep the worker running in one terminal:
63+
64+
```bash
65+
php artisan queue:work
66+
```
67+
68+
Start the example workflow from a second terminal:
69+
70+
```bash
71+
php artisan app:workflow
72+
```
73+
74+
You now have a workflow running through Laravel queues and durable workflow
75+
state. Open `/waterline/dashboard` in the sample app to inspect the run, or
76+
continue with the [sample app guide](/docs/2.0/sample-app).
77+
78+
### I am a Python user
79+
80+
The Python SDK repository includes a deployable order-processing sample. It
81+
starts a local Durable Workflow server, starts a Python worker, runs inventory,
82+
payment, shipment, and confirmation activities, then exits after the workflow
83+
completes.
84+
85+
```bash
86+
git clone https://github.com/durable-workflow/sdk-python.git
87+
cd sdk-python/examples/order_processing
88+
docker compose up --build --exit-code-from python-worker python-worker
89+
docker compose down -v
90+
```
91+
92+
The `python-worker` service prints the completed order result as JSON. A
93+
successful run ends with `status` set to `confirmed`. Continue with the
94+
[Python SDK guide](/docs/2.0/polyglot/python) when you are ready to write your
95+
own workflow and activities.
96+
97+
### I am an operator
98+
99+
Operators usually care about the server, CLI, namespaces, worker health, and
100+
workflow visibility. Use the Python order-processing sample as a real workload,
101+
then inspect it through `dw`.
102+
103+
Start the sample stack and leave it running:
104+
105+
```bash
106+
git clone https://github.com/durable-workflow/sdk-python.git
107+
cd sdk-python/examples/order_processing
108+
docker compose up --build
109+
```
110+
111+
Install and point the CLI at the sample server from another terminal:
112+
113+
```bash
114+
curl -fsSL https://durable-workflow.com/install.sh | sh
115+
116+
export DURABLE_WORKFLOW_SERVER_URL=http://localhost:8080
117+
export DURABLE_WORKFLOW_AUTH_TOKEN=sample-token
118+
export DURABLE_WORKFLOW_NAMESPACE=default
119+
120+
dw server:health
121+
dw workflow:list
122+
```
123+
124+
The stack publishes the server on `localhost:8080`, uses `sample-token`, and
125+
runs a workflow to completion. Clean up when you are done:
126+
127+
```bash
128+
docker compose down -v
129+
```
130+
131+
Continue with the [server setup guide](/docs/2.0/polyglot/server) and
132+
[CLI guide](/docs/2.0/polyglot/cli) for production authentication, deployment,
133+
and operational commands.
134+
135+
## The Loop You Just Ran
136+
137+
1. A client starts a workflow through either Laravel code or the server HTTP
138+
control-plane API.
139+
2. The engine records durable history and creates workflow or activity tasks in
140+
the configured task queue.
141+
3. A worker polls for tasks, executes workflow replay or activity code, and
142+
sends completion commands back to the engine.
143+
4. The engine appends more history, schedules the next task, or marks the
144+
workflow complete.
145+
5. Operators inspect the same durable state through Waterline, the CLI, or the
146+
server API.
147+
148+
That cycle is the product boundary: durable state in the engine, ordinary code
149+
in workers, and HTTP or Laravel APIs for starting and observing work.
150+
33151
# Installation
34152

35153
This guide covers installing the Durable Workflow PHP package for Laravel applications.
@@ -9343,9 +9461,10 @@ asyncio.run(main())
93439461
```
93449462

93459463
For a deployable multi-step example, the SDK repository includes
9346-
`examples/order_processing`: a Docker Compose stack that starts the server,
9347-
runs a Python worker, and completes an order workflow through inventory,
9348-
payment, shipment, and confirmation activities.
9464+
[`examples/order_processing`](https://github.com/durable-workflow/sdk-python/tree/main/examples/order_processing):
9465+
a Docker Compose stack that starts the server, runs a Python worker, and
9466+
completes an order workflow through inventory, payment, shipment, and
9467+
confirmation activities.
93499468

93509469
## Client
93519470

404.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@
1212
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-HD1YHT442Y",{anonymize_ip:!0})</script>
1313

1414

15-
<link rel="search" type="application/opensearchdescription+xml" title="Durable Workflow" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.bdb910b5.css">
16-
<link rel="preload" href="/assets/js/runtime~main.d7682caa.js" as="script">
17-
<link rel="preload" href="/assets/js/main.f3ccfcab.js" as="script">
15+
<link rel="search" type="application/opensearchdescription+xml" title="Durable Workflow" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.5aeb371e.css">
16+
<link rel="preload" href="/assets/js/runtime~main.646eb6ba.js" as="script">
17+
<link rel="preload" href="/assets/js/main.521a1f12.js" as="script">
1818
</head>
1919
<body class="navigation-with-keyboard">
2020
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
2121
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Workflow Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.svg" alt="Workflow Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Durable Workflow</b></a><a class="navbar__item navbar__link" href="/docs/installation/">Docs</a><div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/introduction/">1.x</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/2.0/introduction/">2.0</a></li><li><a class="dropdown__link" href="/docs/introduction/">1.x</a></li></ul></div><a class="navbar__item navbar__link" href="/blog/">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" aria-label="Star Durable Workflow on GitHub" class="navbar-github-star-link navbar__item navbar__link" label="Star on GitHub"><svg aria-hidden="true" class="navbar-github-star-link__icon" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8a8.01 8.01 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.5-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.56 7.56 0 0 1 8 4.76c.68 0 1.36.09 2 .27 1.53-1.03 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.28.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg><span class="navbar-github-star-link__count" title="GitHub stars">1.2K</span></a><a href="https://github.com/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" aria-label="Star Durable Workflow on GitHub" class="navbar-github-star-link navbar__link navbar-github-star-link--mobile-topbar" label="Star on GitHub"><svg aria-hidden="true" class="navbar-github-star-link__icon" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8a8.01 8.01 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.5-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.56 7.56 0 0 1 8 4.76c.68 0 1.36.09 2 .27 1.53-1.03 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.28.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg><span class="navbar-github-star-link__count" title="GitHub stars">1.2K</span></a><div class="toggle_vylO colorModeToggle_x44X"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently dark mode)" aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/introduction/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/installation/">Installation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.gg/xu5aDDpqVy" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://x.com/DurableWorkflow" target="_blank" rel="noopener noreferrer" class="footer__link-item">X<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://durable-workflow.com/llms-full.txt" target="_blank" rel="noopener noreferrer" class="footer__link-item">LLM Docs<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://packagist.org/packages/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" class="footer__link-item">Packagist<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 <a href="https://durable-workflow.com">Durable Workflow</a>.</div></div></div></footer></div></div>
22-
<script src="/assets/js/runtime~main.d7682caa.js"></script>
23-
<script src="/assets/js/main.f3ccfcab.js"></script>
22+
<script src="/assets/js/runtime~main.646eb6ba.js"></script>
23+
<script src="/assets/js/main.521a1f12.js"></script>
2424
</body>
2525
</html>

assets/css/styles.5aeb371e.css

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

assets/css/styles.bdb910b5.css

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)