Installation
Install Sovrium globally or as a project dependency using Bun.
Prerequisites
Sovrium requires Bun 1.3+. A PostgreSQL 15+ database is optional, needed only for data persistence (tables, auth).
Global installation
Install Sovrium globally to use the sovrium command from anywhere:
bun add -g sovrium
Project dependency
Or add Sovrium as a dependency in an existing project:
bun add sovrium
Verify installation
Run the help command to check that Sovrium is installed correctly:
sovrium --help
Create a config file
Sovrium reads a YAML or JSON configuration file. Create an app.yaml with the simplest valid config:
name: my-app
YAML or JSON
Sovrium supports both .yaml/.yml and .json files. YAML is recommended for readability.
Database setup
If your app uses tables or auth, set the DATABASE_URL environment variable:
export DATABASE_URL="postgresql://user:password@localhost:5432/myapp"
No database needed for static sites
If you only use pages and theme (no tables or auth), Sovrium works without a database. Run sovrium build app.yaml to generate a static site.