Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions .changeset/hungry-cats-rush.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@workflow/web-shared": patch
"@workflow/web": patch
---

Add readme section about self-hosting observability UI
6 changes: 4 additions & 2 deletions packages/web-shared/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ Workflow Observability tools for NextJS. See [Workflow DevKit](https://useworkfl

## Usage

This package contains client and server code to interact with the Workflow API.
You can use it like so to display your own runs list:
This package contains client and server code to interact with the Workflow API, as well as some pre-styled components.
If you want to deploy a full observability experience with your NextJS app, take a look at [`@workflow/web`](../web/README.md) instead, which can be self-hosted.

You can use the API to create your own display UI, like so:

```tsx
import { useWorkflowRuns } from '@workflow/web-shared';
Expand Down
12 changes: 12 additions & 0 deletions packages/web/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# @workflow/web

Observability Web UI Package bundled in the [Workflow DevKit](https://useworkflow.dev/docs/observability).

## Self-hosting

While this UI is bundled with the Workflow CLI, you can also self-host it by cloning this repository and
deploying it like any other NextJS app.

For API calls to work, you'll need to pass the same environment variables to the NextJS app that are
used by the Workflow CLI. See `npx workflow inspect --help` for more information on the available environment variables.

If you're deploying this to Vercel, setting `WORKFLOW_TARGET_WORLD` to `vercel` is enough
to infer your other project details. Note that observability will be scoped to the project
and environment you're deploying to.
4 changes: 1 addition & 3 deletions packages/world-postgres/src/cli.ts
Copy link
Member

Choose a reason for hiding this comment

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

missing changeset?

Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
#!/usr/bin/env node

import { config } from 'dotenv';
import { readFile } from 'node:fs/promises';
import { dirname, join } from 'node:path';
import { fileURLToPath } from 'node:url';
import { config } from 'dotenv';
import postgres from 'postgres';

const __dirname = dirname(fileURLToPath(import.meta.url));
Expand Down
14 changes: 7 additions & 7 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.