Skip to content
Marolum documentation contents
Marolum documentation

Marolum documentation

Install Marolum, connect it to your infrastructure, and run it day to day.

Introduction

What Marolum is, what it observes, and the objects you will work with.

Quickstart

Run Marolum on your own machine against a bucket you already have, in about fifteen minutes.

Connect a backend

Declare the state buckets Marolum observes, grant it read-only access, and verify the connection.

Runner integration

Report deployments to Marolum from CI or a developer machine with marolum exec or the ingestion API.

Your first hour

What to do after the first sign-in, what the console shows, and how to know the installation is ready.

Reading the operation timeline

What each part of the Operations page means, and what it deliberately refuses to say.

Database integration and management

Configure SQLite or PostgreSQL, adopt PostgreSQL from SQLite, and run migrations, backups, and restores.

Users and permissions

Bootstrap the first administrator, add accounts, assign roles, issue integration tokens, and secure the installation.

Security and privacy

What Marolum holds, what it refuses to hold, who can reach it, and how to report a problem.

Decommissioning

Retire a Marolum installation cleanly — keep what you must, revoke what you issued, release the license, and know what persists afterwards.

Configuration reference

Every setting Marolum reads, its default, the file rules that apply, and which settings belong to which topology.

Troubleshooting

Symptoms, causes, and fixes for startup, sign-in, backend, storage, and runner problems.

Known limitations

What the current build does not do, in terms you can check against the running product.

Glossary

Every term Marolum uses in the console, the API, and these docs, A to Z, with a link to where it matters.

FAQ

Short answers to the questions that come up first, each linking to the page with the full story.