* docs: document pgvector preinstall for least-privilege DB roles Honcho issues CREATE EXTENSION IF NOT EXISTS vector before migrations and again at server startup, both using the DB_CONNECTION_URI role. On deployments where that role deliberately cannot create extensions (managed Postgres, Kubernetes operators, NixOS), both statements fail with a privilege error — IF NOT EXISTS does not save you, because Postgres checks the privilege before checking for the extension. Document preinstalling pgvector as a privileged role as the supported path, and add a troubleshooting entry keyed to the exact error string. Note that docker compose is unaffected, since the bundled database service creates the extension via an initdb script. Refs #614 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs: clarify why docker compose avoids the pgvector privilege error The previous wording pinned the claim entirely on database/init.sql, which only runs on first boot of an empty data volume. The load-bearing reason is that the bundled stack connects as the postgres superuser, so it can create the extension regardless of volume state. Name that first and keep init.sql as the secondary reason. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| changelog | ||
| images | ||
| logo | ||
| snippets | ||
| v1 | ||
| v2 | ||
| v3 | ||
| README.md | ||
| bun.lock | ||
| docs.json | ||
| favicon.svg | ||
| package.json | ||
README.md
Honcho Docs
These docs are built using Next.js via mintlify.
Setting Up Honcho's Docs Locally
- Clone the repository:
git clone git@github.com:plastic-labs/honcho.git
- Navigate into the
docsfolder:
cd honcho/docs/
The docs folder contains the markdown files that make up the documentation. The majority of the files are in the pages directory. Some notable files in this folder include:
- Verify that you have Node.js and npm installed in your system. You can check by running:
node --version
npm --version
-
If not installed, download Node.js and npm from the respective official websites.
-
Once you have Node.js and npm running, proceed to install
pnpm- another package manager that helps to manage project dependencies:
npm install -g pnpm
- Install the project dependencies using pnpm:
pnpm i
- After the successful installation of the project dependencies, start the local server:
pnpm dev
Now, you should be able to view the docs on your local environment by visiting http://localhost:3000. You can explore the different markdown files and make changes as you see fit.