Skip to content

Quickstart Overhaul #612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kraftp merged 7 commits into from
Aug 21, 2026
Merged

Quickstart Overhaul #612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b0fd2af
quickstart
kraftp Aug 21, 2026
a6b24b2
nit
kraftp Aug 21, 2026
2fc63c0
nit
kraftp Aug 21, 2026
2f5e19f
updates
kraftp Aug 21, 2026
ac3d782
programming guide
kraftp Aug 21, 2026
dbc23ea
edits
kraftp Aug 21, 2026
3e06890
Nit
kraftp Aug 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions docs/golang/programming-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,8 +363,31 @@ Learn more about DBOS queues [here](./tutorials/queue-tutorial.md).
[Conductor](../production/conductor.md) is the control plane for your durable workflows, providing distributed workflow recovery, observability, and management.
Once you connect your app to Conductor, you can view and manage all its workflows and queued tasks from the [DBOS console](https://console.dbos.dev).

To connect your app to Conductor, first register it on the [DBOS console](https://console.dbos.dev) using the name `dbos-starter` (the name must match the `AppName` in your DBOS configuration).
Then, generate an API key from the [key settings page](https://console.dbos.dev/settings/apikey).
To connect your app to Conductor, first sign up for an account on the [DBOS console](https://console.dbos.dev/login-redirect).

Then, install [`dbosctl`](../production/dbosctl.md), the Conductor command-line client.
On Windows, [download a release binary](https://github.com/dbos-inc/dbos-ctl/releases) instead.

```shell
curl -sSfL https://raw.githubusercontent.com/dbos-inc/dbos-ctl/main/install.sh | sh
```

Next, configure a `dbosctl` profile and log in.
`dbosctl login` prints a URL and a code for you to approve in your browser.

```shell
dbosctl config set dbos --managed
dbosctl login
```

Then, register your application with Conductor and create an API key.
The name you register must match the `AppName` in your DBOS configuration.
The key's secret is printed once and cannot be retrieved afterwards, so copy it now.

```shell
dbosctl app register dbos-starter
dbosctl api-key create dbos-starter-key
```

Next, supply your API key to your app through the `ConductorAPIKey` configuration option.
Update the call to `dbos.NewContext` in `main` to read the key from an environment variable:
Expand All @@ -378,7 +401,7 @@ Update the call to `dbos.NewContext` in `main` to read the key from an environme
})
```

Finally, set the `DBOS_CONDUCTOR_KEY` environment variable to the key you generated and restart your app:
Finally, set the `DBOS_CONDUCTOR_KEY` environment variable to the key you created and restart your app:

```shell
export DBOS_CONDUCTOR_KEY=<your-api-key>
Expand Down
29 changes: 26 additions & 3 deletions docs/java/programming-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,8 +359,31 @@ Learn more about DBOS queues [here](./tutorials/queue-tutorial.md).
[Conductor](../production/conductor.md) is the control plane for your durable workflows, providing distributed workflow recovery, observability, and management.
Once you connect your app to Conductor, you can view and manage all its workflows and queued tasks from the [DBOS console](https://console.dbos.dev).

To connect your app to Conductor, first register it on the [DBOS console](https://console.dbos.dev) using the name `dbos-java-starter` (the name must match the application name in your DBOS configuration).
Then, generate an API key from the [key settings page](https://console.dbos.dev/settings/apikey).
To connect your app to Conductor, first sign up for an account on the [DBOS console](https://console.dbos.dev/login-redirect).

Then, install [`dbosctl`](../production/dbosctl.md), the Conductor command-line client.
On Windows, [download a release binary](https://github.com/dbos-inc/dbos-ctl/releases) instead.

```shell
curl -sSfL https://raw.githubusercontent.com/dbos-inc/dbos-ctl/main/install.sh | sh
```

Next, configure a `dbosctl` profile and log in.
`dbosctl login` prints a URL and a code for you to approve in your browser.

```shell
dbosctl config set dbos --managed
dbosctl login
```

Then, register your application with Conductor and create an API key.
The name you register must match the application name in your DBOS configuration.
The key's secret is printed once and cannot be retrieved afterwards, so copy it now.

```shell
dbosctl app register dbos-java-starter
dbosctl api-key create dbos-java-starter-key
```

Next, supply your API key to your app through the `withConductorKey` configuration option.
Update the configuration in `main` to read the key from an environment variable:
Expand All @@ -371,7 +394,7 @@ Update the configuration in `main` to read the key from an environment variable:
.withConductorKey(System.getenv("DBOS_CONDUCTOR_KEY"));
```

Finally, set the `DBOS_CONDUCTOR_KEY` environment variable to the key you generated and restart your app:
Finally, set the `DBOS_CONDUCTOR_KEY` environment variable to the key you created and restart your app:

```shell
export DBOS_CONDUCTOR_KEY=<your-api-key>
Expand Down
29 changes: 26 additions & 3 deletions docs/python/programming-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,8 +248,31 @@ Learn more about DBOS queues [here](./tutorials/queue-tutorial.md).
[Conductor](../production/conductor.md) is the control plane for your durable workflows, providing distributed workflow recovery, observability, and management.
Once you connect your app to Conductor, you can view and manage all its workflows and queued tasks from the [DBOS console](https://console.dbos.dev).

To connect your app to Conductor, first register it on the [DBOS console](https://console.dbos.dev) using the name `dbos-starter` (the name must match the `name` in your DBOS configuration).
Then, generate an API key from the [key settings page](https://console.dbos.dev/settings/apikey).
To connect your app to Conductor, first sign up for an account on the [DBOS console](https://console.dbos.dev/login-redirect).

Then, install [`dbosctl`](../production/dbosctl.md), the Conductor command-line client.
On Windows, [download a release binary](https://github.com/dbos-inc/dbos-ctl/releases) instead.

```shell
curl -sSfL https://raw.githubusercontent.com/dbos-inc/dbos-ctl/main/install.sh | sh
```

Next, configure a `dbosctl` profile and log in.
`dbosctl login` prints a URL and a code for you to approve in your browser.

```shell
dbosctl config set dbos --managed
dbosctl login
```

Then, register your application with Conductor and create an API key.
The name you register must match the `name` in your DBOS configuration.
The key's secret is printed once and cannot be retrieved afterwards, so copy it now.

```shell
dbosctl app register dbos-starter
dbosctl api-key create dbos-starter-key
```

Next, supply your API key to your app through the `conductor_key` configuration option.
Update the configuration in `main.py` to read the key from an environment variable:
Expand All @@ -263,7 +286,7 @@ Update the configuration in `main.py` to read the key from an environment variab
}
```

Finally, set the `DBOS_CONDUCTOR_KEY` environment variable to the key you generated and restart your app:
Finally, set the `DBOS_CONDUCTOR_KEY` environment variable to the key you created and restart your app:

```shell
export DBOS_CONDUCTOR_KEY=<your-api-key>
Expand Down
184 changes: 176 additions & 8 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,50 @@ Congratulations, you've run your first durable workflow with DBOS!
<article className="col col--6">
[Conductor](./production/conductor.md) is the control plane for your durable workflows, providing distributed workflow recovery, observability, and management.

To connect your app to Conductor, first register it on the [DBOS console](https://console.dbos.dev) using the name `dbos-app-starter`, then generate an API key from the [key settings page](https://console.dbos.dev/settings/apikey).
Provide your API key to your app through the `DBOS_CONDUCTOR_KEY` environment variable, then restart it to connect it to Conductor.
To connect your app to Conductor, first sign up for an account on the [DBOS console](https://console.dbos.dev/login-redirect).
</article>

<article className="col col--6">
</article>

<article className="col col--6">
Then, install [`dbosctl`](./production/dbosctl.md), the Conductor command-line client.
On Windows, [download a release binary](https://github.com/dbos-inc/dbos-ctl/releases) instead.
</article>

<article className="col col--6">
```bash
curl -sSfL https://raw.githubusercontent.com/dbos-inc/dbos-ctl/main/install.sh | sh
```
</article>

<article className="col col--6">
Next, configure a `dbosctl` profile and log in.
`dbosctl login` prints a URL and a code for you to approve in your browser.
</article>

<article className="col col--6">
```bash
dbosctl config set dbos --managed
dbosctl login
```
</article>

<article className="col col--6">
Then, register your application with Conductor and create an API key.

@qianl15 qianl15 Aug 21, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to clarify that the API key can be reused for multiple apps?

@kraftp kraftp Aug 21, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not needed in the quickstart, I think (already clarified in docs)

The name you register must match your app's name in its DBOS configuration.
The key's secret is printed once and cannot be retrieved afterwards, so copy it now.
</article>

<article className="col col--6">
```bash
dbosctl app register dbos-app-starter
dbosctl api-key create dbos-app-starter-key
```
</article>

<article className="col col--6">
Finally, provide your API key to your app through the `DBOS_CONDUCTOR_KEY` environment variable, then restart it to connect it to Conductor.
</article>

<article className="col col--6">
Expand Down Expand Up @@ -249,8 +291,50 @@ Congratulations, you've run your first durable workflow with DBOS!
<article className="col col--6">
[Conductor](./production/conductor.md) is the control plane for your durable workflows, providing distributed workflow recovery, observability, and management.

To connect your app to Conductor, first register it on the [DBOS console](https://console.dbos.dev) using the name `dbos-node-starter`, then generate an API key from the [key settings page](https://console.dbos.dev/settings/apikey).
Provide your API key to your app through the `DBOS_CONDUCTOR_KEY` environment variable, then restart it to connect it to Conductor.
To connect your app to Conductor, first sign up for an account on the [DBOS console](https://console.dbos.dev/login-redirect).
</article>

<article className="col col--6">
</article>

<article className="col col--6">
Then, install [`dbosctl`](./production/dbosctl.md), the Conductor command-line client.
On Windows, [download a release binary](https://github.com/dbos-inc/dbos-ctl/releases) instead.
</article>

<article className="col col--6">
```bash
curl -sSfL https://raw.githubusercontent.com/dbos-inc/dbos-ctl/main/install.sh | sh
```
</article>

<article className="col col--6">
Next, configure a `dbosctl` profile and log in.
`dbosctl login` prints a URL and a code for you to approve in your browser.
</article>

<article className="col col--6">
```bash
dbosctl config set dbos --managed
dbosctl login
```
</article>

<article className="col col--6">
Then, register your application with Conductor and create an API key.
The name you register must match your app's name in its DBOS configuration.
The key's secret is printed once and cannot be retrieved afterwards, so copy it now.
</article>

<article className="col col--6">
```bash
dbosctl app register dbos-node-starter
dbosctl api-key create dbos-node-starter-key
```
</article>

<article className="col col--6">
Finally, provide your API key to your app through the `DBOS_CONDUCTOR_KEY` environment variable, then restart it to connect it to Conductor.
</article>

<article className="col col--6">
Expand Down Expand Up @@ -364,8 +448,50 @@ Congratulations, you've run your first durable workflow with DBOS!
<article className="col col--6">
[Conductor](./production/conductor.md) is the control plane for your durable workflows, providing distributed workflow recovery, observability, and management.

To connect your app to Conductor, first register it on the [DBOS console](https://console.dbos.dev) using the name `dbos-go-starter`, then generate an API key from the [key settings page](https://console.dbos.dev/settings/apikey).
Provide your API key to your app through the `DBOS_CONDUCTOR_KEY` environment variable, then restart it to connect it to Conductor.
To connect your app to Conductor, first sign up for an account on the [DBOS console](https://console.dbos.dev/login-redirect).
</article>

<article className="col col--6">
</article>

<article className="col col--6">
Then, install [`dbosctl`](./production/dbosctl.md), the Conductor command-line client.
On Windows, [download a release binary](https://github.com/dbos-inc/dbos-ctl/releases) instead.
</article>

<article className="col col--6">
```bash
curl -sSfL https://raw.githubusercontent.com/dbos-inc/dbos-ctl/main/install.sh | sh
```
</article>

<article className="col col--6">
Next, configure a `dbosctl` profile and log in.
`dbosctl login` prints a URL and a code for you to approve in your browser.
</article>

<article className="col col--6">
```bash
dbosctl config set dbos --managed
dbosctl login
```
</article>

<article className="col col--6">
Then, register your application with Conductor and create an API key.
The name you register must match your app's name in its DBOS configuration.
The key's secret is printed once and cannot be retrieved afterwards, so copy it now.
</article>

<article className="col col--6">
```bash
dbosctl app register dbos-go-starter
dbosctl api-key create dbos-go-starter-key
```
</article>

<article className="col col--6">
Finally, provide your API key to your app through the `DBOS_CONDUCTOR_KEY` environment variable, then restart it to connect it to Conductor.
</article>

<article className="col col--6">
Expand Down Expand Up @@ -484,8 +610,50 @@ Congratulations, you've run your first durable workflow with DBOS!
<article className="col col--6">
[Conductor](./production/conductor.md) is the control plane for your durable workflows, providing distributed workflow recovery, observability, and management.

To connect your app to Conductor, first register it on the [DBOS console](https://console.dbos.dev) using the name `dbos-starter-java`, then generate an API key from the [key settings page](https://console.dbos.dev/settings/apikey).
Provide your API key to your app through the `DBOS_CONDUCTOR_KEY` environment variable, then restart it to connect it to Conductor.
To connect your app to Conductor, first sign up for an account on the [DBOS console](https://console.dbos.dev/login-redirect).
</article>

<article className="col col--6">
</article>

<article className="col col--6">
Then, install [`dbosctl`](./production/dbosctl.md), the Conductor command-line client.
On Windows, [download a release binary](https://github.com/dbos-inc/dbos-ctl/releases) instead.
</article>

<article className="col col--6">
```bash
curl -sSfL https://raw.githubusercontent.com/dbos-inc/dbos-ctl/main/install.sh | sh
```
</article>

<article className="col col--6">
Next, configure a `dbosctl` profile and log in.
`dbosctl login` prints a URL and a code for you to approve in your browser.
</article>

<article className="col col--6">
```bash
dbosctl config set dbos --managed
dbosctl login
```
</article>

<article className="col col--6">
Then, register your application with Conductor and create an API key.
The name you register must match your app's name in its DBOS configuration.
The key's secret is printed once and cannot be retrieved afterwards, so copy it now.
</article>

<article className="col col--6">
```bash
dbosctl app register dbos-starter-java
dbosctl api-key create dbos-starter-java-key
```
</article>

<article className="col col--6">
Finally, provide your API key to your app through the `DBOS_CONDUCTOR_KEY` environment variable, then restart it to connect it to Conductor.
</article>

<article className="col col--6">
Expand Down
29 changes: 26 additions & 3 deletions docs/typescript/programming-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,8 +260,31 @@ Learn more about DBOS queues [here](./tutorials/queue-tutorial.md).
[Conductor](../production/conductor.md) is the control plane for your durable workflows, providing distributed workflow recovery, observability, and management.
Once you connect your app to Conductor, you can view and manage all its workflows and queued tasks from the [DBOS console](https://console.dbos.dev).

To connect your app to Conductor, first register it on the [DBOS console](https://console.dbos.dev) using the name `dbos-node-starter` (the name must match the `name` in your DBOS configuration).
Then, generate an API key from the [key settings page](https://console.dbos.dev/settings/apikey).
To connect your app to Conductor, first sign up for an account on the [DBOS console](https://console.dbos.dev/login-redirect).

Then, install [`dbosctl`](../production/dbosctl.md), the Conductor command-line client.
On Windows, [download a release binary](https://github.com/dbos-inc/dbos-ctl/releases) instead.

```shell
curl -sSfL https://raw.githubusercontent.com/dbos-inc/dbos-ctl/main/install.sh | sh
```

Next, configure a `dbosctl` profile and log in.
`dbosctl login` prints a URL and a code for you to approve in your browser.

```shell
dbosctl config set dbos --managed
dbosctl login
```

Then, register your application with Conductor and create an API key.
The name you register must match the `name` in your DBOS configuration.
The key's secret is printed once and cannot be retrieved afterwards, so copy it now.

```shell
dbosctl app register dbos-node-starter
dbosctl api-key create dbos-node-starter-key
```

Next, supply your API key to your app through the `conductorKey` launch option.
Update the call to `DBOS.launch` in `main` to read the key from an environment variable:
Expand All @@ -270,7 +293,7 @@ Update the call to `DBOS.launch` in `main` to read the key from an environment v
await DBOS.launch({ conductorKey: process.env.DBOS_CONDUCTOR_KEY });
```

Finally, set the `DBOS_CONDUCTOR_KEY` environment variable to the key you generated, then rebuild and restart your app:
Finally, set the `DBOS_CONDUCTOR_KEY` environment variable to the key you created, then rebuild and restart your app:

```shell
export DBOS_CONDUCTOR_KEY=<your-api-key>
Expand Down
Loading