Skip to content

Orimora Documentation

Your team's knowledge base — self-hosted, collaborative, and beautiful.

Install locally

Prerequisites, .env aligned with the repo, migrations, first run, and troubleshooting.

Installation →

Deploy to production

Docker Compose, secrets generation, yarn db:migrate, health checks, reverse proxy and WebSockets.

Deployment →

Configuration

Auth secrets, SMTP, OAuth/OIDC, Redis/Postgres, collaboration, S3, AI encryption keys.

Configuration →

REST API guide

Bearer keys, scopes, rate limits (with real numbers), pagination and incremental sync.

API overview →

OpenAPI reference

Interactive operations for /api/v1/* — request/response schemas generated from Zod.

API reference →

Obsidian plugin

Vault sync, selective pull, frontmatter fields, and conflict strategy.

Obsidian plugin →