Skip to content

v0.3.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 13 Jul 04:17
v0.3.0
4b2ef46
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

The first public release of CompassDocs — an open-source team knowledge platform
for SOPs, technical docs, and policies, with AI-powered search, roles, and an
approval workflow. Self-hosted, AGPL-3.0.

Knowledge & authoring

  • Spaces to organize documents by team, product, or topic — create, edit,
    and manage them from the admin console.
  • Four document types (SOP, technical, policy, how-to) with tags, summaries,
    and per-space browsing.
  • Rich-text editor (WYSIWYG) with a formatting toolbar, plus a raw Markdown
    mode and live preview — both edit the same document.
  • AI proofreading for grammar, spelling, and clarity, with apply-or-dismiss
    suggestions.
  • Full-text search with keyword highlighting and a ⌘K quick-search.
  • Ask CompassDocs — AI answers grounded in your own documents, with inline
    citations. Falls back to keyword search when no API key is set.
  • Version history — every change is snapshotted and attributed.
  • Attachments and inline images, with a configurable size limit.
  • Import & export the whole knowledge base as front-matter Markdown.

Governance

  • Roles — Viewer, Editor, Approver, Admin — with a last-admin guard.
  • Approval workflow — strict (review-required) or open publishing, with a
    review queue for change requests and suggestions.
  • Trash & retention — soft-delete with restore and a configurable
    auto-purge window.
  • Audit log — an append-only record of security- and content-significant
    actions (auth, users, content, settings, backups); secrets are never logged.

Administration

  • Settings console — branding, timezone, date/time formats, light/dark/auto
    theme, idle session timeout, and more.
  • AI configuration — set the Anthropic API key (validated on save) and model
    from the UI.
  • Custom domain & HTTPS — a bundled Caddy proxy with automatic Let's Encrypt,
    self-signed, or bring-your-own certificates, configured from the console.
  • Backups & restore — scheduled full-database backups with retention and
    one-click restore, mirrored off-site to S3-compatible storage or Azure Blob.
  • System page — version, database, storage, and resource usage at a glance.
  • Update checker — see when a newer release is available, with the upgrade
    command.

Deployment

  • One-command Docker install with a browser-based first-run setup wizard.
  • Multi-arch images (linux/amd64 and linux/arm64), published to
    ghcr.io/mattny20/compassdocs.
  • PostgreSQL storage; the app migrates its own schema on start.
  • Also runs manually with Node.js 20+ and PostgreSQL 14+.
Assets 2
Loading