Skip to content

README.md

Latest commit

 

History

History
39 lines (24 loc) · 1.31 KB

README.md

File metadata and controls

39 lines (24 loc) · 1.31 KB
Raw

Plainbase Ask

An AI-powered customer support widget you self-host. Connects to your knowledge base, answers questions, and escalates to a ticket when needed.

Check out all Plainbase tools at plainbase.dev.

Quick start

1. Clone and configure:

cp .env.example .env
# Fill in AI_PROVIDER, AI_API_KEY, AI_MODEL, EMBEDDING_MODEL, ADMIN_PASSWORD

2. Start:

docker compose up -d --build

3. Open the admin at http://localhost:3000/admin, add your documents, and configure the widget.

4. Embed the widget by copying the snippet from the Widget page in the admin and pasting it into your site.

For production, put a reverse proxy in front (Coolify, Koyeb, Railway, or your own Nginx/Caddy) to handle HTTPS. The app listens on port 3000.

Backups

The app stores data in two SQLite files. Litestream is bundled in the Docker image and can stream both files to any S3-compatible bucket in real time — just set LITESTREAM_S3_BUCKET and credentials in .env.

Full documentation

See docs/00-getting-started.md for:

  • How the app works and sizing guidance
  • Recommended European hosting providers (Hetzner, Scaleway, Koyeb…)
  • Litestream backup setup (Scaleway, Cloudflare R2, MinIO)
  • Full environment variable reference