Open-source AI coworkers that each get a computer of their own: a browser, files and tools, with every action decided before it happens and recorded after. Bring any AG-UI agent.
Release v0.0.9 (#492)
David McKayef50d202141b
diff --git a/prompt.txt b/prompt.txtindex 28130ff7..8ed2d420 100644--- a/prompt.txt+++ b/prompt.txt@@ -1,9 +1,55 @@-You are helping somebody set up OpenBot on their own machine, from a fresh clone.+You are helping somebody set up OpenBot on their own machine.Read this whole file before running anything. Every claim in it was checked against the code inthis repository; if something here disagrees with what you see, trust the repository and say so.-WHAT OPENBOT IS+ASK THIS BEFORE YOU DO ANYTHING ELSE++There are two ways to have OpenBot and they are different jobs. Ask which one they want:++ A. They want to run it. One container, one command, nothing cloned and nothing built. The image+ carries the app, the API, Chromium, and its own PostgreSQL if asked.+ B. They want to make it theirs. The clone, run from source, with the Bots, channels and skills as+ configuration they edit. That is the rest of this file.++"I want to try OpenBot" is A. Go to B only if they mean to change something: their own Bots, their+own channels, their own skills, or the code. Somebody who wanted A and was walked through B has+installed a toolchain and a container engine to see a screen that one command would have shown them.++A. A LOCAL COPY, FROM THE PUBLISHED IMAGE++ docker run -p 3001:3001 --env-file .env \+ -e EMBEDDED_POSTGRES=on -v openbot-data:/var/lib/postgresql \+ ghcr.io/copilotkit/openbot:latest++One port. The app is on 3001 as well, so open http://localhost:3001, not 3010. `latest` is the most+recent release; a version tag such as `:v0.0.9` pins one.++The `.env` still carries the same values as B: INTELLIGENCE_API_KEY, a model key, a real+KEY_ENCRYPTION_KEY, and either an identity provider or OPENBOT_SINGLE_USER=true. Start from+`.env.example` in this repository, or write the handful by hand. `EMBEDDED_POSTGRES=on` runs+PostgreSQL inside the container, creates the database and the `vector` extension the first time, and+applies the migrations on every start, so there is nothing to provision and no password to manage.+Point DATABASE_URL at a database you already run instead, and leave EMBEDDED_POSTGRES off, if you+would rather. That database needs the `vector` extension enabled; the managed ones support it and+none of them enable it for you.++Mount the volume at `/var/lib/postgresql`, the parent, not `/var/lib/postgresql/data`. `initdb` will+not initialise into a directory that holds anything, and an ext4 volume arrives holding+`lost+found`, so mounting the data directory itself leaves the cluster uncreated and the container+serving nothing.++WHAT THIS IMAGE DOES NOT CARRY: `agent-langgraph` and `agent-bot`, the two framework Bots, are+separate images that `docker-compose.yml` starts. Leave MANAGED_AGENT_AG_UI_URL unset and the+shipped Risk Analyst coworker is omitted rather than registered against a host that is not there. If+their `.env` still has the laptop default `http://localhost:4201/ag-ui`, unset it. Somebody who+wants those Bots wants B.++docs/deployment.md is the whole of this path, including the managed-database version, the sizing and+the platform notes.++B. MAKE IT THEIRS, FROM THE CLONE+OpenBot is a template to clone and make your own, not a product with a hosted version. It runs onthe person's machine: their PostgreSQL, their model credential, their Bots.@@ -15,7 +61,7 @@ WHAT THEY NEED BEFORE STARTING- A model credential. `OPENAI_API_KEY` is the default; any OpenAI-compatible base URL works via`OPENAI_BASE_URL`.-THE ONLY THREE VALUES A PERSON HAS TO SUPPLY+THE ONLY TWO VALUES A PERSON HAS TO SUPPLY`.env.example` ships ten empty keys, which makes this look bigger than it is. `scripts/start.sh`fills most of them itself: it defaults COMPUTER_TOKEN and WORKER_SHARED_SECRET, and generatesAGENT_TOOL_TOKEN and writes it back into `.env`. What it cannot invent is:@@ -24,7 +70,7 @@ AGENT_TOOL_TOKEN and writes it back into `.env`. What it cannot invent is:2. OPENAI_API_KEY the model credentialEverything else in `.env.example` is either already correct or generated. Do not talk the person-through the other seven.+through the other eight.THE STEPS@@ -45,6 +91,9 @@ Then:It starts Docker services, applies migrations, starts the API on 3001 and the app on 3010, andwaits for each to answer its own health route before printing next steps. Open http://localhost:3010.+`bash scripts/stop.sh` takes down everything it started, the Bots' computers included. The database,+the files and the browser profiles are volumes, so nothing is deleted either way.+WHAT YOU MUST NOT DO FOR THEM- Do not run `copilotkit login`. It opens a browser and signs in as them. Tell them to run it.- Do not put their API keys into any file you did not just tell them about, and do not echo the@@ -80,8 +129,9 @@ The server refuses to start rather than running half-configured. The message namHOW TO KNOW IT WORKEDcurl -s localhost:3001/api/capabilities-Expect JSON with "mode":"intelligence". Then open http://localhost:3010 and send a message to-General Assistant. A reply means the model credential and Intelligence are both good.+Expect JSON with "mode":"intelligence". Then open the app and send a message to General Assistant.+A reply means the model credential and Intelligence are both good. The app is on 3010 from the+clone and on 3001 from the image.WHEN THEY WANT TO MAKE IT THEIRSThe Bots, channels and skills are configuration, not code: `examples/fintech` is a worked example,@@ -91,4 +141,5 @@ copy. That is the fork, and it is the point of the repository.Watch the path: the server runs from `server/`, so TENANT_PACKAGE_DIR is relative to that, which iswhy the default reads `../examples/fintech` rather than `examples/fintech`.-Further reading: README.md, docs/development.md, and docs/configuration.md for every variable.+Further reading: README.md, docs/development.md, docs/deployment.md, and docs/configuration.md for+every variable.diff --git a/tests/smoke/journey.test.ts b/tests/smoke/journey.test.tsindex 69212258..49132708 100644--- a/tests/smoke/journey.test.ts+++ b/tests/smoke/journey.test.ts@@ -16,11 +16,36 @@ import { beforeAll, describe, expect, test } from "bun:test";** `OPENBOT_API_URL` points it at a deployment on other ports. Without `OPENBOT_SMOKE` the file is* skipped, so `bun run test` stays honest on a machine with nothing running.+ *+ * IT ALSO NEEDS A SESSION, AND SAYS SO RATHER THAN FINDING OUT THREE TIMES.+ *+ * Everything this journey exists to prove is behind `requireUser`: minting a thread id, acting on a+ * Bot's computer, reading the policy, reading the trail. This file sent no credentials, so on any+ * deployment with an identity provider configured -- which is every deployment this repository will+ * start -- three of its five tests answered `401 Authentication required`, and had since the guard+ * was added. A release checklist that asks whether the journey passed was therefore asking for a+ * result nobody could produce.+ *+ * So `OPENBOT_SMOKE_COOKIE` carries a signed-in session, sent verbatim as the `cookie` header. It is+ * a cookie rather than a token because that is what this deployment issues: Better Auth is+ * configured here with social and OIDC providers and no bearer plugin, so a session lives in a+ * cookie and nothing else opens these routes. Take it from a browser already signed in to the+ * deployment under test: DevTools, Application, Cookies, the `better-auth.session_token` entry, sent+ * as `better-auth.session_token=<value>`. It is a credential with that person's reach, so treat it+ * as one: it belongs in the environment of the run and not in a file, a log or a comment on a pull+ * request.+ *+ * OPENBOT_SMOKE_COOKIE='better-auth.session_token=...' bun run test:smoke+ *+ * Without it the run stops before the first test with a sentence naming it, rather than skipping the+ * half that matters and reporting the other half as a pass. A journey that did not act on a computer+ * has not been run.*/const asked = process.env.OPENBOT_SMOKE === "1";const API = process.env.OPENBOT_API_URL ?? "http://localhost:3001";const BOT = process.env.OPENBOT_SMOKE_BOT ?? "risk-analyst";+const COOKIE = process.env.OPENBOT_SMOKE_COOKIE ?? "";/** Long enough for a computer to be created and Chromium to answer on a cold deployment. */const COMPUTER_TIMEOUT_MS = 180_000;@@ -28,7 +53,11 @@ const COMPUTER_TIMEOUT_MS = 180_000;async function api(path: string, init?: RequestInit): Promise<Response> {return fetch(`${API}${path}`, {...init,- headers: { "content-type": "application/json", ...(init?.headers ?? {}) },+ headers: {+ "content-type": "application/json",+ ...(COOKIE ? { cookie: COOKIE } : {}),+ ...(init?.headers ?? {}),+ },});}@@ -52,6 +81,24 @@ beforeAll(async () => {`No deployment is answering at ${API}. Start one with \`bash scripts/start.sh\`, or set OPENBOT_API_URL.`,);}++ if (!COOKIE) {+ throw new Error(+ "This journey acts as a person, and every route it proves is behind a session. Set " ++ "OPENBOT_SMOKE_COOKIE to the `better-auth.session_token=...` cookie of a browser signed in " ++ `to ${API}. See the comment at the top of this file.`,+ );+ }++ // Asked once, here, so a session that is missing, expired or from another deployment is one+ // sentence at the start rather than the same 401 read three different ways further down.+ const accepted = await api("/api/computers/policy");+ if (accepted.status === 401) {+ throw new Error(+ `The session in OPENBOT_SMOKE_COOKIE is not accepted by ${API}. It may have expired, or belong ` ++ "to a different deployment. Sign in again and take a fresh one.",+ );+ }});describe.skipIf(!asked)("a deployment that is up", () => {