kumbuka

README

Keep your knowledge close.
A small, self-hosted, Markdown-first wiki for documentation.

Kumbuka is the PostgreSQL-backed server and web application. It includes authentication, revision history, search, media, collaboration, administration, themes, and the plugin runtime.

Project-oriented tooling lives in the separate Kumbuka CLI. Use kumbuka-cli for static-site builds, Markdown mirrors, and .kumbukaplugins management.

Plugin development

Create, test, and build Go/WASI plugins with the Kumbuka Plugin SDK and CLI. First-party plugins live in kumbuka-me/plugins; bundled and installed packages use the same public API and sandboxed runtime.

Quick start

Start Kumbuka with Docker Compose:

docker compose -f deploy/compose.yaml up -d

By default, Kumbuka is available at:

http://localhost:8080

On a fresh database, open Kumbuka and create the first administrator through the setup page.

The server binary has no subcommands. Running kumbuka starts the server directly:

kumbuka \
  --database-url 'postgres://USER:PASS@HOST:5432/kumbuka?sslmode=disable' \
  --listen-address 0.0.0.0:8080 \
  --public-url http://localhost:8080

Common settings

Environment variables use the KUMBUKA__ prefix.

Setting	Default	What it changes
KUMBUKA__LISTEN_ADDRESS	127.0.0.1:8080	Address and port Kumbuka listens on.
KUMBUKA__PUBLIC_URL	http://localhost:8080	Externally visible URL of the Kumbuka installation.
KUMBUKA__DATABASE_URL	—	PostgreSQL connection URL.
KUMBUKA__PLUGIN_UPDATE_CHECK_INTERVAL	15m	Checks the first-party plugin catalog on this interval; 0 disables scheduled checks while manual checks remain available.
KUMBUKA__READ_ONLY	false	Blocks state-changing application requests while keeping reads and authentication available.
KUMBUKA__ALLOW_USER_REGISTRATION	—	Overrides whether unknown OIDC or trusted-proxy identities may create accounts.
KUMBUKA__LOCAL_LOGIN	false	Enables the local recovery login alongside the configured authentication mode.
KUMBUKA__TRUSTED_GROUP_HEADERS	X-Forwarded-Groups,X-Auth-Request-Groups	Trusted-proxy group headers used with the trusted-proxy authentication override.
KUMBUKA__TRUSTED_ADMIN_GROUP	—	Trusted-proxy group that grants administrator access with the authentication override.
KUMBUKA__OIDC_GROUP_CLAIM	groups	OIDC group-membership claim used with the OIDC authentication override.
KUMBUKA__OIDC_ADMIN_GROUP	—	OIDC group that grants administrator access with the authentication override.

See the documentation for all settings and authentication options.

CLI

Install or build kumbuka-me/cli for offline/project commands:

kumbuka-cli build --help
kumbuka-cli mirror --help
kumbuka-cli plugins --help

License

Licensed under the Apache License, Version 2.0.