selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

Oxynote logo

Self-host Oxynote

v0.9.3

Technical wiki with live metrics and review flows

BetaOpen SourceApache-2.0
Updated13 hours ago
LanguageGo
Setup difficultyModerate
ThemeDark mode
Stars
426
Port
8080 (HTTP web interface and API)
Docker
ghcr.io/oxynote/oxynote
Install with Docker
Review interface showing a draft page with block-level diff (removed text in red, added in green) and approve button

What is Oxynote?

Oxynote is a self-hosted workspace for technical documentation that puts live metric charts next to the text explaining them. It lets engineering teams write internal API docs with Stripe-style split views, run Prometheus and SQL queries directly in pages, and route every change through a draft branch with block-level diffs and approvals. Pages support real-time collaborative editing with comments, a page tree with tags and full-text search, and both light and dark themes. The built-in AI assistant (Rubber Duck) can edit pages and run the same queries as metric blocks, with support for Anthropic, OpenAI, Google, OpenRouter, and local models via Ollama. MCP clients like Claude Code and Codex can access the same tools over OAuth. Oxynote runs as a single Docker image (ghcr.io/oxynote/oxynote) that bundles Caddy, the Nuxt/Vue frontend, a Go API server, a Node auth/realtime service (Better Auth + Hocuspocus/Yjs), and an embedded PostgreSQL database. Optional external dependencies include Valkey/Redis for caching, S3-compatible object storage, an SMTP relay, and changedetection.io for URL watching. Authentication supports built-in email/password plus social login via GitHub, Google, or Slack. The project is licensed Apache-2.0 and currently at v0.9.0 (pre-1.0 beta).

Should you self-host Oxynote?

Oxynote scores 49/100 on selfhost.directory (how scoring works) and ranks #22 of 42 in Knowledge Management. It has 426 GitHub stars.

It shipped 10 stable releases in the past year. The latest, v0.9.3, came out on 27 October 2026. New versions land roughly every 2 days.

Setup is moderate: expect some configuration beyond a single command. An official Docker image is available. It is Apache-2.0-licensed and written mostly in Go.

Its closest alternative on selfhost.directory is AppFlowy (82/100, 77 896 stars). It scores higher overall, so compare the two before you pick. See Oxynote vs AppFlowy side by side.

Features

  • AI assistant (Rubber Duck)
  • Comments and threads
  • Freshness hooks
  • Full-Text Search
  • Keyboard Shortcuts
  • Live metric charts
  • MCP Server
  • Page tree with tags
  • Real-time collaborative editing
  • Review flows with drafts, diffs, and approvals
  • Rich content blocks
  • Social login (GitHub, Google, Slack)
  • Stripe-style split API documentation
  • Workspaces with invitations

Oxynote README

How to install Oxynote

Install Oxynote with Docker

Docker

docker run -d --name oxynote
-p 8080:8080
-v oxynote_data:/oxynote/data
ghcr.io/oxynote/oxynote:latest

Single container with embedded PostgreSQL; data persisted in named volume.

Oxynote releases & version history

FAQ

Why the name Oxynote?

Internally it was first called "breathing docs". Breathing needs oxygen, so "oxy" became the prefix and "note" followed.

Does it replace Grafana?

That is the goal. Today it covers metric charts and dashboard-style grids from Prometheus and SQL with explanations written next to them. Logs and alerting are not there yet but are being worked on.

More in Knowledge Management

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…