Single source of truth for Birkly CMS documentation

Reference for future closed-alpha self-host trials — not an open invite program. When your team runs a cohort, use this alongside Self-host install and Known issues (Wave 1).

Closed alpha means Birkly is mature enough for real self-hosted trials but not a public beta. Expect rough edges. Testers use the CMS on their own server, report bugs via in-admin Feedback, and read Help for live Birkly-Docs. Support: hello@birkly.io.

What is in this alpha

AreaWhat to test
BYOAIConnect your provider (OpenAI, Claude, Ollama, …), assign a role, try chat read/write and approval queue
MCPOptional: connect Claude Desktop with a per-connection MCP key
AutomationEnable the automation plugin; create a webhook or scheduled workflow
User pluginRegistration, login, collection permissions
ContentEditorBlock components (callout, quote, CTA, table, image) — save and reload entries
MarketplaceInstall free official plugins; paid/subscription checkout on marketplace.birkly.io
CommerceMulti-currency products, live import, warehouse stock, inventory webhooks
Cloud accountOptional link on Account page (local login still primary)
Admin UXLight/dark/system theme toggle; mobile-friendly dashboard and Commerce
HelpLive docs from Birkly-Docs with offline snapshot fallback
FeedbackSubmit bug/idea from the admin Feedback widget; confirm it appears in Feedback admin

Getting started

  1. Install Birkly on a server or local PHP (see Self-host install and Getting started).
  2. Complete onboarding (project name, first admin user).
  3. Open Help (sidebar) for contextual docs — Read full doc opens Birkly-Docs topics.
  4. Install plugins from Plugins → Hub (Commerce, Events, Automation, User Management).
  5. Connect AI under Settings → AI — start with Ollama locally if you have no API key.
  6. Optionally link cloud account under Account (does not replace local password).

Reporting issues

Use Feedback in the admin (not only email) so we capture:

  • Your message and category (bug / idea / other)
  • Optional screenshot note
  • Page URL, CMS version, and browser info

We use this data only to improve the alpha (see Alpha legal and website Privacy Policy). Include steps to reproduce for bugs.

What not to expect yet

  • Production SLA or 24/7 support
  • Managed hosting from us — you self-host
  • Full public marketplace without QC review for verified tier
  • FX conversion between currencies (set each price explicitly)

Useful doc links