Skip to content

The only tool you need to know what is happening and how to fix it.

feat: docs updated

dduxdc340c94ee6a
diff --git a/backend/traceway.go b/backend/traceway.go
index 5e0e9864..cc2e4881 100644
--- a/backend/traceway.go
+++ b/backend/traceway.go
@@ -1,3 +1,11 @@
+// Package tracewaybackend provides an embeddable Traceway backend that can be
+// run inside your own Go application.
+//
+// !! WARNING: Linux and macOS only.
+// !! The embedded backend uses chdb (embedded ClickHouse), which does NOT
+// !! support Windows. libchdb must be installed on the system before use:
+// !!
+// !! curl -sL https://lib.chdb.io | bash
package tracewaybackend
import "github.com/tracewayapp/traceway/backend/cmd"
diff --git a/docs/pages/learn/embedded-mode.mdx b/docs/pages/learn/embedded-mode.mdx
index a3f82125..ced9a7a3 100644
--- a/docs/pages/learn/embedded-mode.mdx
+++ b/docs/pages/learn/embedded-mode.mdx
@@ -1,5 +1,11 @@
# Embedded Mode
+import { Callout } from 'nextra/components'
+
+<Callout type="warning">
+**Linux and macOS only.** Embedded mode uses [chdb](https://github.com/chdb-io/chdb) (embedded ClickHouse), which does **not** support Windows. If you're on Windows, use the [Docker Compose](/server/docker-compose) deployment instead.
+</Callout>
+
Embedded mode runs a full Traceway server inside your Go process — using **SQLite** instead of PostgreSQL and **embedded ClickHouse** (via [chdb](https://github.com/chdb-io/chdb)) instead of an external server. No Docker, no infrastructure — just one `tracewaybackend.Run()` call and your app has local observability.
This is intended for **local development only**. For production, use the [Docker Compose](/server/docker-compose) or [minimal](/server/minimal) deployment.