24.04
Back
Intro
Why integrate?
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
Troubleshooting
Misc
Collabora Online for Kubernetes
Deploying Collabora Online in Kubernetes
Kubernetes cluster monitoring
Dynamic/Remote configuration in kubernetes
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
SSL configuration
Security settings
Validating digital signatures
Backend storage configurations
Logging
Performance
Allowed dictionary languages
Admin Console
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.
Package upgrade issues
Webserver restart
Diagnostic capabilities
Case studies
Case study No. 1
Case study No. 2
Get Started
Introduction
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
Available integrations
Alfresco integration
Drupal integration
EGroupware integration
Mattermost integration
Moodle integration
Collaborative document editing
Collaborative submissions
Nextcloud integration
ownCloud integration
SharePoint integration
Advanced integration
CheckFileInfo response properties
BaseFileName
DisablePrint
OwnerID
PostMessageOrigin
Size
TemplateSource
UserCanWrite
UserCanNotWriteRelative
UserId
UserFriendlyName
CheckFileInfo extended response properties
IsAdminUser
IsAnonymousUser
EnableInsertRemoteImage
DisableInsertLocalImage
HidePrintOption
HideSaveOption
HideExportOption
DisableExport
DisableCopy
DisableInactiveMessages
DownloadAsPostMessage
SaveAsPostmessage
EnableOwnerTermination
UserExtraInfo
UserPrivateInfo
Document signing
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
Documentation
Architecture
WSD
ForKit
Kit
Kit Isolation
Architecture
File System
Client Connection
Tile Rendering
Protocol
Threading
File Server
Communication Security
Personal data flow
Cookies and local storage
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
Conversion API
Extract/Transform API
General Usage:
General Extract:
General Transform:
Content Controls:
Extract
Transform
Screenshot
Example Files
Charts:
Extract
Transform
Screenshot
Example Files
Document Properties:
Extract
Transform
Screenshot
Example Files
Version updates:
Linking API
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:
Grammar checker (LanguageTool)
Collabora Online
LibreOffice Core
Translator (DeepL)
Collabora Online
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
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?
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
»
Index
Index
Other formats
PDF
EPUB