Skip to content
Syntaxlab-devPublic

About

A self-hosted knowledge base for teams - one line to install, no admin overhead.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Compendo

A self-hosted knowledge base for teams — one line to install, no admin overhead.

Spaces, a real block editor, comments, permissions, full-text search, and an importer that gets your Confluence content out in one piece.

License: AGPL v3


Why

Most self-hosted wikis ask you to run Postgres, Redis, an object store and a search cluster before you can write your first page. Most hosted ones charge per seat and keep single sign-on behind an enterprise plan.

Compendo is the other way around:

  • One command installs it. A single script writes the compose file, brings up the container and its database, and hands you a URL.
  • A guided web installer asks the rest — database, admin account, example content, language, backup target — and checks each answer before continuing.
  • Single sign-on is not a paid extra. OIDC ships with the normal build.
  • Your backups leave the machine. SFTP, Hetzner Storage Box and Strato HiDrive are configured in the interface, encrypted, with a restore test you can actually run.
  • Nothing calls home. No telemetry, no external fonts, no third-party requests from the application.

Status

Early development — the foundation is being built in the open. Follow ROADMAP.md for what lands when. Not yet ready to hold your team's documentation.

Install

curl -fsSL https://compendo.dev/install.sh | sh

The script needs Docker and writes everything into the directory you run it in. It prints a URL and a setup token; open the URL, and the web installer takes it from there.

Prefer to do it yourself? docker-compose.yml in this repository is the same file the script writes.

Development

docker compose -f docker-compose.dev.yml up --build

Backend on :8000, frontend dev server on :5173, Postgres on :5433. Tests: docker compose -f docker-compose.dev.yml run --rm api pytest.

License

AGPL-3.0. Run it, change it, host it for your company — but if you offer it to others as a service, your changes go back to everyone.

About

A self-hosted knowledge base for teams - one line to install, no admin overhead.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages