oxynote
Oxynote is a self-hosted workspace that combines live metric charts, Notion-style documentation, Stripe-style API docs, and pull-request-style reviews in one container.
Ficha actualizada 22 sept 2026, 18:32 · upstream 22 sept 2026, 16:54 · release v0.7.0
Qué es oxynote
Descripción editorial construida a partir del repositorio, su documentación y sus señales de mantenimiento.
Oxynote is a self-hosted platform that unifies several tools into a single interface. It provides live metric charts next to explanatory text, Stripe-style split documentation for real-time systems, and review flows similar to GitHub pull requests. Built on the foundation of [ttlcache](https://github.com/jellydator/ttlcache), it is designed for teams that need observability alongside documentation without maintaining separate tools.
- Monitoring service health with live charts displayed alongside explanations
- Maintaining consistent documentation across multiple services in one place
- Reviewing code changes through a diff-based process before merging into main
- Collaborating on pages where comments and replies are visible to all team members
- Running automated queries against Prometheus or SQL databases with results displayed inline
- Managing deployment procedures with versioned snapshots and approval workflows
- Single container solution that bundles metric grids, live docs, review flows, and collaboration into one image
- Supports multiple database backends including PostgreSQL, MySQL, and MariaDB for time series data storage
- Draft-based change management with diff visualization showing both text and structural changes
- Live collaborative editing where comments attach to specific elements like charts or code blocks
- Freshness hooks that track dependency changes (GitHub files, container images, web pages) and notify maintainers
- Rubber Duck assistant with multiple model integrations including local Ollama instances
- No native alerting or log aggregation capabilities beyond what is already in Grafana
- No built-in CI/CD pipeline integration for automated deployment triggers
- Limited support for external monitoring tools like Datadog (requires manual configuration)
- No native support for serverless functions or edge computing environments
- Documentation and metric charts are tightly coupled per page, making cross-service navigation less intuitive
Perfil de infraestructura
Estimación inicial derivada del repositorio y de los servicios detectados.
Despliegue detectado
Qué señales reales de instalación hemos encontrado.
Deploy Oxynote as a single container using Docker Compose: `docker run -d --name oxynote -p 8080:8080 -v oxynote_data:/oxynote/data ghcr.io/oxynote/oxynote:latest`. For production, use the [prod image](https://github.com/oxynote/oxynote/blob/main/docker/prod/Dockerfile) with environment variables for database credentials and model configuration. The container exposes port 8080 on the host. Use a volume mount to persist data between restarts.
Stack y dependencias
Componentes inferidos a partir de manifests, configuración y documentación.
Puede sustituir a
Relaciones detectadas por el análisis del repositorio y su categoría.
Experiencia real de la comunidad
Ayuda a contrastar la estimación automática con instalaciones reales.
Todavía no hay datos comunitarios para este proyecto.