Skip to content
27 pages, 6 sections

Everything you need to run BottleCRM.

Feature guides, API reference, integration samples, and self-hosting playbooks, written for people who want to ship, not wade through 200 pages of marketing.

Written against the code that ships. Where something is built but not reachable yet, the page says so rather than describing the screen it does not have.

Start here

Three ways in, depending on why you came.

Most people arrive doing one of these three things, and the shortest route differs for each.

Evaluating it

See whether it fits

Start with what the product is and the vocabulary the rest of the docs use, then read the module you care about most.

Introduction
Running it

Get it up on your own box

The Docker Compose stack brings up Postgres, Redis, the API, a Celery worker and the web app. Then read the environment variables and the row-level security setup.

Docker guide
Building on it

Talk to the API

JWT auth, an OpenAPI schema, and Swagger and Redoc served by the backend. The mobile app is a client of the same API, which is the only guarantee that matters.

Authentication
The whole portal

Every page, grouped.

Six sections, 27 pages. Counts come from the navigation manifest, so this list cannot drift from the sidebar.

Mobile app

Building and installing the Flutter client for Android and iOS from source.

1

Something missing, or something wrong?

The docs live in the same public repository as the product, so a correction is a pull request rather than a support ticket. Every page here was rewritten against the code.

MIT licensed · Issues and pull requests welcome