Pre-alpha. No tagged release and no upgrade path between versions. Use for evaluation and development only, not production.
DevelopersPre-alpha

Installation

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

Pre-alpha. Sumeru has no tagged release and no upgrade path. Fine for local eval and addon work. Do not run production on it.

Requirements

  • Go 1.26+
  • PostgreSQL
  • Checkouts of sumeru, sumeru_addons and sumeru_custom_addons as sibling directories (typical layout)

Nothing else: no Node, no Docker, no message broker, no external cache.

Create the database

Terminal
shell
psql -U postgres -c "CREATE DATABASE sumeru;"

Workspace config

All commands below run from your workspace module, sumeru_custom_addons.

Terminal
shell
cd sumeru_custom_addonscp sumeru.conf.example sumeru.confedit 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.

Point the workspace at the other two modules

Terminal
shell
make replace-sumeru        SUMERU_ROOT=../sumerumake replace-sumeru-addons ADDONS_ROOT=../sumeru_addonsmake generate

make generate rewrites addonimports/zimports.go, the blank imports that link every discovered addon into the binary. Run it whenever you add an addon.

Verify the toolchain

Terminal
shell
go versionpsql -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.