Skip to content

DOC-3498: tinymceai on-prem documentation.#4137

Draft
kemister85 wants to merge 5 commits into
feature/8.6.0/DOC-3401from
feature/8.6.0/DOC-3401_DOC-3498
Draft

DOC-3498: tinymceai on-prem documentation.#4137
kemister85 wants to merge 5 commits into
feature/8.6.0/DOC-3401from
feature/8.6.0/DOC-3401_DOC-3498

Conversation

@kemister85
Copy link
Copy Markdown
Contributor

@kemister85 kemister85 commented May 13, 2026

Ticket

DOC-3498

Summary

Complete on-premises deployment documentation for the TinyMCE AI service. This introduces 10 new pages covering every aspect of self-hosted AI deployment, from initial setup through production hardening and advanced scenarios.

New pages (10)

Page Scope
Overview Architecture, capabilities, prerequisites, setup paths, and support
Getting started Five-minute Docker Compose quick start with end-to-end smoke test
Database, Redis, and storage MySQL/PostgreSQL setup, Redis configuration, container runtimes, and managed cloud options
LLM providers OpenAI, Anthropic, Google Gemini, Azure OpenAI, AWS Bedrock, Google Vertex AI, and self-hosted endpoints (Ollama, vLLM, LM Studio)
JWT authentication HS256 signing model, claims, permissions reference, and token endpoint examples in 8 languages
Framework integration Editor-side configuration, token provider, CORS, CSP, and SSR patterns
Production deployment Podman, Kubernetes, AWS ECS, scaling, security hardening, observability, rate limiting, backup/recovery, and sizing
Advanced scenarios MCP integration, web scraping/search, multi-tenant patterns, custom models with guardrails, and AI-powered document pipelines
Troubleshooting Quick triage, container startup, JWT, LLM provider, editor, and performance diagnostics
Reference Environment variables, API endpoints, SSE events, error codes, and known limits

Assets

  • 20 Mermaid .mmd source files with pre-rendered .svg diagrams
  • Render script at -scripts/render-mermaid.sh
  • All diagrams set to width=100% for responsive scaling

Navigation

nav.adoc updated with a new "On-premises deployment" section containing all 10 pages in logical reading order.

Pre-checks

  • Branch prefixed with feature/<version>/
  • modules/ROOT/nav.adoc has been updated
  • Included a release note entry for any New product features
  • If this is a minor release, updated productminorversion in antora.yml and added new supported versions entry in modules/ROOT/partials/misc/supported-versions.adoc

Review

  • Documentation Team Lead has reviewed

Add missing customer-facing content identified by comparing the
original internal documentation against the current on-premises
AsciiDoc pages: capabilities matrix on the overview page, Podman
production runbook, performance characteristics table, expanded
known limits reference, MySQL 8.4 caveat, Ollama systemd and
Modelfile examples, and getting-started teardown and config update
guidance.
Expand 18 acronyms (OCI, JWT, LLM, SSE, TLS, CORS, MCP, NTP, HPA,
OTLP, IRSA, ADC, SSR, CSP, SIEM, PII, HA, mTLS) on first prose
occurrence per page for readers unfamiliar with the terms.
Comment thread modules/ROOT/images/tinymceai-on-premises/advanced-scenarios-fig-1.mmd Outdated
Comment thread modules/ROOT/images/tinymceai-on-premises/complete-guide-fig-1.mmd Outdated
Comment thread modules/ROOT/images/tinymceai-on-premises/complete-guide-fig-9.mmd
Comment thread modules/ROOT/images/tinymceai-on-premises/troubleshooting-fig-1.mmd
Comment thread modules/ROOT/pages/tinymceai-on-premises.adoc Outdated
Comment thread modules/ROOT/pages/tinymceai-on-premises.adoc
Comment thread modules/ROOT/pages/tinymceai-on-premises.adoc Outdated
Comment thread modules/ROOT/pages/tinymceai-on-premises.adoc Outdated
Comment thread modules/ROOT/pages/tinymceai-on-premises.adoc Outdated
Comment thread modules/ROOT/pages/tinymceai-on-premises-frameworks.adoc Outdated
Reduce edge clutter by connecting a single representative replica
to downstream services and grouping the data layer into a subgraph.
Fix SVG width to use a fixed pixel value consistent with other
diagrams in the set.
tiny-ben-tran

This comment was marked as spam.

@tiny-ben-tran tiny-ben-tran self-requested a review May 14, 2026 23:18
- Generalize overview page for standalone API use, not just TinyMCE
- Swap complex architecture diagram for simplified overview diagram
- Move detailed enterprise topology to production page (collapsible)
- Fix capabilities table: chat, document review, file attachments, scaling
- Redis: mark Sentinel as not supported
- Remove TinyMCE 8.0+ from prerequisites (not required for API-only)
- Reverse proxy changed from required to recommended
- Fix decision tree cross-references (Section 33 -> guide names)
- Replace troubleshooting flowchart with ordered triage list
- Rename "Framework integration" to "TinyMCE integration" across all refs
- Fix API key reference for on-prem (license key or API key)
- Reorder support section docker commands for logical flow
- Make MCP diagram arrows bidirectional
- LLM providers: clarify native vs OpenAI-compatible providers
- Re-render all mermaid diagrams
@kemister85
Copy link
Copy Markdown
Contributor Author

Moved this PR to #4142 as a hotfix

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants