LyEve Documentation
LyEve is a headless CMS you run yourself. You define the shape of your content, write it in the admin console or over the API, and your sites, apps and services read it as JSON. It runs on your own servers against your own database, so the content and the accounts stay with you.
It is for developers who build sites and apps on content, operators who run the instance, editors who write in the admin console, and teams that want one content store behind several brands or customers. The core CMS and a set of features are free with no time limit. A license key adds the paid features, and the same images serve both.
Choose your path
Section titled “Choose your path”| I want to... | Start here |
|---|---|
| Try it in ten minutes | Quickstart |
| Model my content | Your first content type, then the data model |
| Build a site or app on it | Developer guide |
| Automate work with flows | Flows and the flow templates |
| Run it in production | Operator guide and the production checklist |
| Edit content as an editor | User guide |
| Evaluate it for my company | Company guide and licensing and tiers |
| See everything it can do | Features |
New to LyEve? Getting started puts the first pages in order, and core concepts explains the handful of ideas the rest of the docs assume.
What you run
Section titled “What you run”| Piece | What it does | Where it comes from |
|---|---|---|
| Engine | Stores your content and accounts in your database, and answers every request over two HTTP APIs: one to manage the instance, one to read and write content. It has no screens of its own | The image ghcr.io/lyeve-labs/lyeve-core |
| Admin console | The web interface where editors write and administrators configure. It calls the engine for you | The image ghcr.io/lyeve-labs/lyeve-admin |
| Database | Holds everything: PostgreSQL, MySQL 8 or later, or SQL Server and Azure SQL | You provide it, on your own server or a managed service |
Your own code can call the APIs directly or through the TypeScript packages on npm (SDK overview). Core concepts explains the two APIs, and Source code says what is published and under which license.
Find something specific
Section titled “Find something specific”- How-to guides: task walkthroughs such as adding a webhook or backing up an instance.
- Deployment: Docker Compose, Kubernetes and hosted platforms.
- Configuration and API endpoints: every setting and every route.
- Glossary: short definitions of the terms these pages use.
- Pricing: plans and prices.