Logo
25.04
  • Back

Intro

  • Introduction

Setup and configuration

  • Installation guide
    • Installation from packages
      • The Installation Procedure
        • Collabora’s Partner
        • CODE
        • Distro-specific Installation Instructions
          • Debian, Ubuntu, other deb based Linux distribution
          • RHEL, CentOS, and their derivatives
          • SLES 15 / openSUSE Leap 15.x
        • How to upgrade
        • Localization
        • Spelling dictionaries and thesauri
    • Docker images
      • Pre-made Docker images
      • Build Docker image
      • Create a container from the image and run it
    • CODE Docker image
      • How to grab the CODE image from Docker image
      • How to configure Docker image
        • 1. Setting the application configuration dynamically via environment variables
        • 2. Use the configuration file directly
      • Container Security and Capability Management
        • Running with Minimal Capabilities
        • Custom Seccomp profile
        • Troubleshooting
        • Misc
    • Collabora Online for Kubernetes
      • Deployment Methods
      • Prerequisites
      • Deploying COOL/CODE with standard Helm chart
      • COOL Controller
        • Access credentials
        • Get latest version information
        • Deploying Collabora Online with COOL Controller
        • Enable direct communication between COOL and COOL Controller within a Kubernetes cluster
      • Additional configuration
        • Kubernetes cluster monitoring
        • Dynamic/Remote configuration in kubernetes
        • Installing Custom Fonts
          • Method: Using a PersistentVolumeClaim (PVC)
          • Prerequisites
          • Step-by-Step Guide
        • Kubernetes Security Context for Restricted Environments
          • Running with Minimal Capabilities
          • Custom Seccomp Profile for Maximum Restriction
        • OpenShift Security Context for Restricted Environments
          • Security Configuration Options
          • Option 1: Custom Seccomp Profile
            • Step 1: Create Custom SCC
            • Step 2: Configure Service Account Bindings
            • Step 3: Configure Helm Values
          • Option 2: Restricted SCC Approach
          • Option 3: Privileged SCC
        • Useful commands to check what is happening
    • Fonts
      • Metric-compatible free fallback fonts for various proprietary fonts used in Office Open XML documents
      • Other free bundled fonts
    • Updating systemplate
    • Configuration
      • User interface settings
      • Overwrite mode
      • Help url
      • Network settings
      • Base URL
      • SSL configuration
      • Security settings
      • Validating digital signatures
      • Backend storage configurations
      • Logging
      • Performance
      • Allowed dictionary languages
      • Admin Console
      • Server Audit
      • Monitoring usage metrics
      • Feature Locking
        • To allow/deny feature_lock per WOPI host:
      • Feature Restriction
      • Multihost Configuration
      • Remote/Dynamic Configuration
        • Enable remote server configuration by adding url
        • JSON format
        • Enable download and availability of more fonts by pointing to a font configuration file
        • Remote font configuration JSON format
        • AutoSave settings
      • Other settings
    • Proxy settings
      • Reverse proxy with Apache 2 webserver
        • Configure Collabora Online
        • Required Apache2 modules
        • Reverse proxy settings in Apache2 config (SSL)
        • Reverse proxy settings in Apache2 config (SSL termination)
      • Reverse proxy with Nginx webserver
        • Reverse proxy settings in Nginx config (SSL)
        • Reverse proxy settings in Nginx config (SSL termination)
      • Load balancing
        • Example with HAProxy
        • Example with Nginx
      • robots.txt
  • Troubleshooting
    • Symptom-based Troubleshooting
      • Service Unavailable (error 503)
      • Gray document area, no document loaded
      • Network connectivity problems
      • Load balancing problems
      • ‘Unauthorized WOPI host error’ when opening a file.
    • ‘External data source not allowed’ when trying to insert content (image, clipboard paste).
    • Further symptoms
      • Tiles load slowly or missing when working with a file.
      • File does not display correctly or editing actions do not give expected result.
      • Issues that were supposed to be fixed in the current version are present.
      • Using different domain for Collabora Online and embedding application.
      • Cannot print in Chrome
    • Package upgrade issues
      • Webserver restart
    • Diagnostic capabilities
      • Checking network connectivity between Collabora Online and the WOPI host
    • Case studies
      • Case study No. 1
      • Case study No. 2
  • Grammar checker (LanguageTool)
    • Collabora Online
    • LibreOffice Core
  • Translator (DeepL)
    • Collabora Online
  • Available integrations
    • Alfresco integration
    • Drupal integration
    • EGroupware integration
    • Ilias integration
    • Mattermost integration
    • Moodle integration
      • Collaborative document editing
      • Collaborative submissions
    • Nextcloud integration
    • ownCloud integration
    • SharePoint integration
    • WordPress™ integration
  • Integrations setup
    • ILIAS
      • Installation
      • Configuration
      • Usage
      • More info
    • Mattermost
      • Installation
      • Configuration
      • Source code
    • Moodle
      • Installation
      • Configuration
        • Main configuration
        • Templates
      • Usage
      • Source code
        • Collaborative document editing
        • Collaborative submissions
    • WordPress™
      • Installation
      • Configuration
        • Extra configuration
      • Usage
      • Source code

Integrating

  • Introduction
  • Why integrate?
    • Support
  • Architecture
    • WSD
    • ForKit
    • Kit
    • Kit Isolation
    • Architecture
    • File System
    • Client Connection
    • Tile Rendering
    • Protocol
    • Threading
    • File Server
    • Communication Security
  • How to integrate
    • Server for hosting Collabora Online
    • Website that presents the editing capabilities
    • Authentication
    • Connection to the file storage
    • Re-using our development / demo-servers
    • Further differences to WOPI
  • Step-by-step tutorial
  • Simple examples
    • Node.js example
    • PHP example
    • Python example
    • ReactJS example
    • .NET example
  • Personal data flow
  • Cookies and local storage

Customising

  • Advanced integration
    • CheckFileInfo response properties
      • BaseFileName
      • DisablePrint
      • OwnerID
      • PostMessageOrigin
      • Size
      • SupportsRename
      • TemplateSource
      • UserCanRename
      • UserCanWrite
      • UserCanNotWriteRelative
      • UserId
      • UserFriendlyName
    • CheckFileInfo extended response properties
      • IsAdminUser
      • IsAnonymousUser
      • EnableInsertRemoteImage
      • EnableRemoteLinkPicker
      • EnableInsertRemoteFile
      • EnableRemoteAIContent
      • DisableInsertLocalImage
      • HidePrintOption
      • HideSaveOption
      • HideExportOption
      • DisableExport
      • DisableCopy
      • DisableInactiveMessages
      • UserCanOnlyComment
      • UserCanOnlyManageRedlines
      • DownloadAsPostMessage
      • SaveAsPostmessage
      • EnableOwnerTermination
      • UserExtraInfo
      • UserPrivateInfo
        • Document signing
      • ServerPrivateInfo
        • Electronic signature handling
      • UserSettings
      • SharedSettings
      • WatermarkText
    • PostMessage extensions
      • App_LoadingStatus
    • PutFile headers
    • Detecting external document change
    • Checking for available features
    • Modifying discovery.xml
    • Override CheckFileInfo
    • Clipboard handling
      • Allow the clipboard permission query
      • Extensions to the HTML clipboard
        • HTML marker
        • Spreadsheet HTML extensions
    • URL query parameters
    • Content Security Policy
    • Full Screen
    • WOPI proof
    • Update checker
      • Checking the version
      • Checking for an update
        • Examples
    • Setup Settings iframe
      • Authentication
      • iframe Type
      • Connect to File Storage
      • Fetch settings
      • Upload settings
      • Delete settings file
      • Browser settings
      • Theming Settings iframe
        • Dark/Light mode
        • Content of hidden field css_variables
      • Adjusting iframe height
  • Theming of Collabora Online
    • How that works and how it looks
    • User Interface modifications
    • Extra hidden field in COOL frame integration
    • Content of hidden field “css_variables”
    • Available variables
    • What it is, and how it looks
  • Server macros in Python
    • Description
    • Background
    • Python script files
    • Instructions
      • Forms and JavaScript in framed.html and framed.doc.html
      • Sample Scripts
        • SetCellColor:
        • GetNamedRanges:
        • AddNamedRange:
        • DeleteNamedRange:
        • InsertText:
  • PostMessage API
    • Initialization
    • Query
    • Session Management
      • WOPI Host to editor
      • Editor to WOPI Host
    • Actions
      • WOPI host to editor
      • WOPI editor to host (Response)
    • Version Restore
      • WOPI host to editor
      • Editor to WOPI host
    • Miscellaneous
      • WOPI host to editor
      • Finding toolbar button IDs
      • Finding status bar element IDs
      • Editor to WOPI host
    • Calling Python scripts
      • WOPI host to editor
      • Editor to WOPI host
    • Mentions
      • Editor to WOPI host
      • WOPI host to editor
    • Embedding Iframe

APIs

  • Conversion API
    • Supported Input Formats
    • Supported Output Formats
    • Optional Parameters
      • lang – Language (locale)
      • options – Export Filter Options
        • PDF Filter Options
          • Options from the General tab of PDF Export dialog
          • Options from the Initial View tab of PDF Export dialog
          • Options from the User Interface tab of PDF Export dialog
          • Options from the Links tab of PDF Export dialog
          • Options from the Security tab of PDF Export dialog
          • Options for Digital Signatures
        • CSV Filter Options
      • infilterOptions – Import Filter Options
    • Deprecated Parameters
      • PDFVer – PDF Version
      • FullSheetPreview – Fit the entire worksheet on one page
    • Examples
  • Extract/Transform API
    • Data types
    • General Usage
      • General Extraction
        • Items
      • General Transform
        • Commands
        • UNO Commands
    • Content Controls
      • Extract
      • Transform
      • Screenshot
      • Example Files
    • Charts
      • Extract
      • Transform
      • Screenshot
      • Example Files
    • Document Properties
      • Extract
      • Transform
      • Screenshot
      • Example Files
    • Tracked changes
      • Extract
      • Example Files
    • Slides
      • Extract
      • Transform
      • Screenshot
      • Example Files
    • JSON validity changes
      • Extract
      • Transform
    • Version updates
  • Linking API

More Information

  • FAQ
    • Which programs are included in the office suite?
    • Which formats can the programs of Collabora Online read?
    • In which formats can documents etc. be exported?
    • Do the programs run in a browser and / or as local clients?
    • Do the programs require an uninterrupted network connection?
    • Can you add a storage system?
    • Can you write and use your own plug-ins with the programs?
    • High availability, fault tolerance, upgrade-ability?
    • Is it safe to restart the service without losing data?
    • Do the documents leave the server?
    • What is CODE? Are there non-development editions too?
    • What are the possibilities to test your products?
    • Can I host your product on my own environment?
  • Contact
SDK
  • »
  • Search

© Copyright 2025, Collabora. Buy the supported version 💜

Built with Sphinx, custom theme based on sphinx rtd by Read the Docs.
25.04
Current:
25.04
Stable:
24.04
Older versions
Versions
23.05
Downloads
PDF
EPUB