First boot

Initialise the database in setup mode, install the addons you need, then run the server.

First boot: setup mode

$make run$Database is not initialized. Starting in SETUP MODE.$Visit http://localhost:8080/setup to initialize the system.

There is no default admin account. The wizard at /setup creates your company and the first user; the email you give it becomes the login.

Install the business addons

$make install MODULES=contacts,product,crm,sale,sale_crm,account,purchase,hr

Install order matters and follows depends. You can name modules explicitly, use make install MODULES=all, or explore the pre-shipped kitchen-sink demo with make install MODULES=engagement_cookbook.

Run it

$make run$Server starting on :8080...#open http://localhost:8080/  ->  /web/home

The inner loop for a new addon

#new custom module (minimal scaffold)$make new MODULE=my_app$make install MODULES=my_app#after editing XML or manifest data$make update MODULES=my_app$make run

make run runs generate, then assets (rebuilds SWC when sources changed), then starts the HTTP server. Go code changes need a rebuild (make run). XML changes need make update, because views, menus and access rules live in the database once installed. For the full widget and view-type reference, see Engagements cookbook.

For business teams

Once the server is up, operators use Apps, roles and the lead-to-cash flow. Those guides live under Business:

• Business overview: apps, roles, multi-company
• Lead-to-cash: the flow that works today, plus known gaps

Next step

Developers: continue with Creating an addon. Business readers: start at Business overview.

What not to do

• Do not hunt for a default password; complete /setup.
• Do not edit XML and expect a rebuild alone to reload it; use -u.
• Do not run production workloads on pre-alpha.

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