Installation

Create a database, configure the workspace, and point it at the core and standard addon modules.

Requirements

• Go 1.26+
• Node.js (npm — builds SWC workspace UI; bundles are gitignored)
• PostgreSQL
• Checkouts of sumeru, sumeru_addons and sumeru_custom_addons as sibling directories (typical layout)

make setup wires go.mod replaces, regenerates imports, and builds client assets when missing. Docker, a message broker, and external cache are not required.

Create the database

$psql -U postgres -c "CREATE DATABASE sumeru;"

Workspace config

All commands below run from your workspace module, sumeru_custom_addons.

$cd sumeru_custom_addons$cp sumeru.conf.example sumeru.conf#edit db_host / db_user / db_password / db_name / http_port (default 8080)

Paths inside the INI resolve against the file itself, not your shell. The addons_path key decides which addons exist at all. Default listen port is 8080. Details: Configuration.

Bootstrap the workspace

$make setup#go.mod replaces, imports, SWC + login JS bundles$make run#regenerate imports; rebuild assets when missing or stale

make setup runs replace-sumeru, replace-sumeru-addons, make generate (rewrites addonimports/zimports.go), and make assets (delegates to ../sumeru for SWC bundles). Run make generate again whenever you add an addon folder.

Verify the toolchain

$go version$node --version$npm --version$psql -U postgres -c "SELECT version();"

Next step

Continue with Configuration if you need every key explained, or jump to First boot to run the setup wizard.

What not to do

• Do not run server commands from the core or addons module; use the workspace.
• Do not skip make generate after adding an addon folder.
• Do not assume Docker is required; it is not.

Sumeru is pre-alpha (no tagged release, no upgrades). Part of Project Meru.