DOC-3498: tinymceai on-premises documentation#4142
Merged
Conversation
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.
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.
- 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
Registry URL confirmed as registry.containers.tiny.cloud/ai-service-tiny.
a80cb4c to
260ed25
Compare
5 tasks
- Soften privacy claim to clarify LLM provider data handling - Reword data flow steps (JWT, prompt phrasing) - Clarify setup path section and topic guide introduction - Remove orphan diagrams (troubleshooting-fig-1, complete-guide-fig-9) - Remove "Must include" from plugins table, fix troubleshooting wording - Replace MySQL 8.4 references with "the latest MySQL" across all pages - Add provenance NOTE to performance characteristics - Consolidate production page diagrams (promote complete-guide-fig-1) - Improve overview and providers diagram layouts (LR, spacing) - Move provider examples out of collapsible block for visibility
Remove Performance characteristics and Sizing guide from the production page until engineering provides verified data.
Fix Redis Sentinel contradiction, add terminationGracePeriodSeconds and PDB to K8s manifest, add S3 credentials and topology spread, bootstrap step after Service manifest, HPA I/O-bound caveat, managed database TLS section, Docker network resolution for Compose v2, MODELS requirement clarification, and assorted cross-links and callouts identified during the independent evaluation audit.
metricjs
reviewed
May 20, 2026
metricjs
reviewed
May 20, 2026
metricjs
reviewed
May 20, 2026
metricjs
reviewed
May 20, 2026
metricjs
reviewed
May 20, 2026
metricjs
reviewed
May 20, 2026
- Fix project folder name: tinymce-ai-onpremise → tinymceai-onpremise - Replace CDN script tag with locally served tinymce and tinymce-premium - Rename LICENSE_KEY to AI_LICENCE_KEY in .env and docker run - Remove TINYMCE_API_KEY (not needed for self-hosted editor) - Add license_key init option with inline guidance - Add tinymce and tinymce-premium (^8.4.0) to package.json
This reverts commit 8909888. The NPM self-hosted approach requires using plugin name 'ai' (on-premises) instead of 'tinymceai' (cloud-only, CDN), and the tinymce-premium NPM package does not include the tinymceai plugin. Reverting to CDN approach until the plugin naming and static serving are resolved.
Update mkdir command to use tinymceai-onpremise and rename LICENSE_KEY to AI_LICENCE_KEY across .env template, docker run command, and related notes.
Document the new OAuth 2.0 Authorization Code with PKCE flow for MCP servers, including configuration, Dynamic Client Registration, authorization flow, REST endpoints, and troubleshooting. Update reference page with MCP_OAUTH_CALLBACK_URL env var and corrected authentication notes. Update overview page feature table to mention OAuth support.
Add license validation notes to the overview, getting-started, and production pages clarifying that the AI service contacts license.containers.tiny.cloud on startup and that no customer data is transmitted during the check.
ArvinJ-H
approved these changes
May 27, 2026
metricjs
reviewed
May 27, 2026
metricjs
reviewed
May 27, 2026
metricjs
reviewed
May 27, 2026
Rewrite MCP server example to use stateless per-request pattern (fixes crash on second request with SDK v1.29.0). Add package.json snippet with pinned SDK version and type:module. Add container name conflict and port 3000 tips to getting-started page.
Switch the getting-started demo from CDN-loaded TinyMCE to a self-hosted bundle served from node_modules. Add license_key init option, licensekeymanager plugin, and instructions for copying the tinymceai plugin into the plugins directory. Also quote .env placeholders, split source/docker-run blocks, clarify network naming, and update credential notes.
metricjs
reviewed
May 28, 2026
metricjs
reviewed
May 28, 2026
metricjs
reviewed
May 28, 2026
metricjs
reviewed
May 28, 2026
metricjs
reviewed
May 28, 2026
metricjs
reviewed
May 28, 2026
metricjs
approved these changes
May 28, 2026
Sync validated MCP content: OAuth URL discovery (RFC 9728), minimal callback page, browser proxy pattern, and mixed internal/external server config example. Remove Atlassian- specific examples pending further testing. Fix license endpoint typo in production page and .env placeholder inconsistency in getting-started guide.
Getting-started: add bold labels and diagnostic guidance to each verification step for readability. Database: fix double underscore in table namespace list, add PostgreSQL skip note. JWT: rename heading to Editor-side configuration. MCP: reorder config table (oauth after headers), remove redundant OAuth cross-ref, mention MCP_OAUTH_CALLBACK_URL in config intro, change "changes" to "steps". Reference: clarify MCP auth wording, add OAuth endpoints to API table.
The original time estimate was unrealistic for first-run setups that include image pulls and Management Panel configuration.
…manager, expand port tip Remove angle brackets from remaining .env placeholders, drop licensekeymanager from plugins list, and convert the port-conflict tip to a block with a code snippet for easier copy-paste.
tiny-ben-tran
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Ticket
DOC-3498
Summary
Complete on-premises deployment documentation for the TinyMCE AI service, cherry-picked from
feature/8.6.0/DOC-3401_DOC-3498(#4137) and retargeted totinymce/8for independent merge.New pages (10)
Assets
.mmdsource files with pre-rendered.svgdiagrams-scripts/render-mermaid.shwidth=1200for consistent sizingNavigation
nav.adocupdated with a new On-premises deployment section. Reading order: Overview, Getting started, Database, LLM providers, JWT authentication, TinyMCE integration, Production deployment, MCP and web integrations (optional), Troubleshooting, Reference.Pre-checks
hotfix/8/modules/ROOT/nav.adochas been updated