Home

AstroBaaS wiki

AstroBaaS is a self-hostable, TypeScript-native backend with a content admin built in: authentication, data, a REST API and file storage in one Node process. You can use it as a CMS that renders your site, or as a headless backend for a frontend you build yourself. It is free software under GPL-3.0-or-later, and there is no licence check anywhere in the code.

Status: pre-alpha (0.1.x). What works is listed in the README, and so is what doesn't yet. Read Security before putting an install on the internet.

This wiki is the guided tour. Each page explains a part of AstroBaaS and links to the full reference file in the repository when you need every detail.

Start here

If you want to…	Read
Run it on your machine in five minutes	Installation
See every setting and environment variable	Configuration
Find your way around the admin	Admin tour
Put it on a server	Deployment
Build a separate frontend on top of it	Headless and REST API
Model your own content: events, menus, team members	Custom content types
Change how the site looks	Themes
Add features in code	Plugins

Quick start

Requires Node 22.12 or newer.

git clone https://github.com/operator888/astrobaas.git
cd astrobaas
npm install
npm run dev        # http://localhost:4321

Sign in at http://localhost:4321/login with admin@local / admin. That default only works in development; see Installation for creating a real admin and running a production build.

All pages

Getting started Installation · Configuration · Admin tour

Using the CMS Content and media · Custom content types · Internationalisation · Importing

Building with AstroBaaS Headless and REST API · SDK, CLI and MCP · Webhooks · Architecture

Extending Themes · Plugins

Commerce and email Commerce · Payments · Email

Operating an install Deployment · Staging and maintenance · Backups and storage · Security · Upgrading

Project Contributing and licensing · FAQ and troubleshooting

Two ways to use one install

• As a CMS. The public site is server-rendered HTML with almost no client JavaScript, and the admin at /admin is ordinary HTML forms. Publishing is a write to the database, not a rebuild.
• As a headless backend. Point any frontend at the REST API with a bearer API key and the site's origin in CORS_ORIGINS. There is a typed SDK, a CLI, an MCP server for AI agents, signed webhooks, and machine-readable contracts at /openapi.json and /llms.txt.

Getting help

• Something broken? Check FAQ and troubleshooting, then open an issue.
• Questions and ideas go to Discussions.
• Security problems: follow SECURITY.md, never a public issue.