Research Collaborra interation #486
Closed
opened 2026-09-11 20:11:05 +00:00 by Cordy
·
4 comments
No Branch/Tag specified
main
b12v07
b11v07
b10v07
ci-rc-publish
fx15-s3dry
b9v07
b8v07
bench742
b7v07
legal-texts-v0.2
b6v07
b5v07
b4v07
b3v07
sx1139
st742
b2v07
ix1102
fu1098
zp1097
wd1099
tr1100
qf1077
nc1070
ci1
rp1072
lk1073
ab1071
fi1074
si1070
ra1054
wo1056
oc1057
tf1055
sv1063
fg1059
st1058
fs929
mu1039
ls1033
cf975
lf835
dx1023
ml896
a11y2
av1022
r913
r7
r6
r5
r45
r23
r1
b10
b9
fix-b5
fix-b4
fix-b3
fix-b2
fix-b1
fix-922
fix-923
fix-911
fix-343b
batch-a
v0.6.413
v0.6.412
v0.6.411
v0.6.410
v0.6.409
v0.6.408
v0.6.407
v0.6.406
v0.6.405
v0.6.404
v0.6.403
v0.6.402
v0.6.401
v0.6.400
v0.6.399
v0.6.398
v0.6.397
v0.6.396
v0.6.395
v0.6.394
v0.6.393
v0.6.392
v0.6.391
v0.6.390
v0.6.389
v0.6.388
v0.6.387
v0.6.386
v0.6.385
v0.6.384
v0.6.383
v0.6.382
v0.6.381
v0.6.380
v0.6.379
v0.6.378
v0.6.377
v0.6.376
v0.6.375
v0.6.374
v0.6.373
v0.6.372
v0.6.371
v0.6.370
v0.6.369
v0.6.368
v0.6.367
v0.6.366
v0.6.365
v0.6.364
v0.6.363
v0.6.362
v0.6.361
v0.6.360
v0.6.359
v0.6.358
v0.6.357
v0.6.356
v0.6.355
v0.6.354
v0.6.353
v0.6.352
v0.6.351
v0.6.350
v0.6.349
v0.6.348
v0.6.347
v0.6.346
v0.6.345
v0.6.344
v0.6.343
v0.6.342
v0.6.341
v0.6.340
v0.6.339
v0.6.338
v0.6.337
v0.6.336
v0.6.335
v0.6.334
v0.6.333
v0.6.332
v0.6.331
v0.6.330
v0.6.329
v0.6.328
v0.6.327
v0.6.326
v0.6.325
v0.6.324
v0.6.323
v0.6.322
v0.6.321
v0.6.320
v0.6.319
v0.6.318
v0.6.317
v0.6.316
v0.6.315
v0.6.314
v0.6.313
v0.6.312
v0.6.311
v0.6.310
v0.6.309
v0.6.308
v0.6.307
v0.6.306
v0.6.305
v0.6.304
v0.6.303
v0.6.302
v0.6.301
v0.6.300
v0.6.299
v0.6.298
v0.6.297
v0.6.296
v0.6.295
v0.6.294
v0.6.293
v0.6.292
v0.6.291
v0.6.290
v0.6.289
v0.6.288
v0.6.287
v0.6.286
v0.6.285
v0.6.284
v0.6.283
v0.6.282
v0.6.281
v0.6.280
v0.6.279
v0.6.278
v0.6.277
v0.6.276
v0.6.275
v0.6.274
v0.6.273
v0.6.272
v0.6.271
v0.6.270
v0.6.269
v0.6.268
v0.6.267
v0.6.266
v0.6.265
v0.6.264
v0.6.263
v0.6.262
v0.6.261
v0.6.260
v0.6.259
v0.6.258
v0.6.257
v0.6.256
v0.6.255
v0.6.254
v0.6.253
v0.6.252
v0.6.251
v0.6.250
v0.6.249
v0.6.248
v0.6.247
v0.6.246
v0.6.245
v0.6.244
v0.6.243
v0.6.242
v0.6.241
v0.6.240
v0.6.239
v0.6.238
v0.6.237
v0.6.236
v0.6.235
v0.6.234
v0.6.233
v0.6.232
v0.6.231
v0.6.230
v0.6.229
v0.6.228
v0.6.227
v0.6.226
v0.6.225
v0.6.224
v0.6.223
v0.6.222
v0.6.221
v0.6.220
v0.6.219
v0.6.218
v0.6.217
v0.6.216
v0.6.215
v0.6.214
v0.6.213
v0.6.212
v0.6.211
v0.6.210
v0.6.209
v0.6.208
v0.6.207
v0.6.206
v0.6.205
v0.6.204
v0.6.203
v0.6.202
v0.6.201
v0.6.200
v0.6.199
v0.6.198
v0.6.197
v0.6.196
v0.6.195
v0.6.194
v0.6.193
v0.6.192
v0.6.191
v0.6.190
v0.6.189
v0.6.188
v0.6.187
v0.6.186
v0.6.185
v0.6.184
v0.6.183
v0.6.182
v0.6.181
v0.6.180
v0.6.179
v0.6.178
v0.6.177
v0.6.176
v0.6.175
v0.6.174
v0.6.173
v0.6.172
v0.6.171
v0.6.170
v0.6.169
v0.6.168
v0.6.167
v0.6.166
v0.6.165
v0.6.164
v0.6.163
v0.6.162
v0.6.161
v0.6.160
v0.6.159
v0.6.158
v0.6.157
v0.6.156
v0.6.155
v0.6.154
v0.6.153
v0.6.152
v0.6.151
v0.6.150
v0.6.149
v0.6.148
v0.6.147
v0.6.146
v0.6.145
v0.6.144
v0.6.143
v0.6.142
v0.6.141
v0.6.140
v0.6.139
v0.6.138
v0.6.137
v0.6.136
v0.6.135
v0.6.134
v0.6.133
v0.6.132
v0.6.131
v0.6.130
v0.6.129
v0.6.128
v0.6.127
v0.6.126
v0.6.125
v0.6.124
v0.6.123
v0.6.122
v0.6.121
v0.6.120
v0.6.119
v0.6.118
v0.6.117
v0.6.116
v0.6.115
v0.6.114
v0.6.113
v0.6.112
v0.6.111
v0.6.110
v0.6.109
v0.6.108
v0.6.107
v0.6.106
v0.6.105
v0.6.104
v0.6.103
v0.6.102
v0.6.101
v0.6.100
v0.6.99
v0.6.98
v0.6.97
v0.6.96
v0.6.95
v0.6.94
v0.6.93
v0.6.92
v0.6.91
v0.6.90
v0.6.89
v0.6.88
v0.6.87
v0.6.86
v0.6.85
v0.6.84
v0.6.83
v0.6.82
v0.6.81
v0.6.80
v0.6.79
v0.6.78
v0.6.77
v0.6.76
v0.6.75
v0.6.74
v0.6.73
v0.6.72
v0.6.71
v0.6.70
v0.6.69
v0.6.68
v0.6.67
v0.6.66
v0.6.65
v0.6.64
v0.6.63
v0.6.62
v0.6.61
v0.6.60
v0.6.59
v0.6.58
v0.6.57
v0.6.56
v0.6.55
v0.6.54
v0.6.53
v0.6.52
v0.6.51
v0.6.50
v0.6.49
v0.6.48
v0.6.47
v0.6.46
v0.6.45
v0.6.44
v0.6.43
v0.6.42
v0.6.41
v0.6.40
v0.6.39
v0.6.38
v0.6.37
v0.6.36
v0.6.35
v0.6.34
v0.6.33
v0.6.32
v0.6.31
v0.6.30
v0.6.29
v0.6.28
v0.6.25
v0.6.24
v0.6.23
v0.6.22
v0.6.21
v0.6.20
v0.6.19
v0.6.18
v0.6.17
v0.6.16
v0.6.15
v0.6.14
v0.6.12
v0.6.11
v0.6.10
v0.6.9
v0.6.8
v0.6.7
v0.6.6
v0.6.5
v0.6.4
v0.6.3
v0.6.2
v0.6.1
v0.6.0
v0.5.7
v0.5.6
v0.5.5
v0.5.4
v0.5.3
v0.5.2
v0.5.1
v0.5.0
v0.4.12
v0.4.11
v0.4.10
v0.4.9
v0.4.8
v0.4.7
v0.4.6
v0.4.5
v0.4.4
v0.4.3
v0.4.2
v0.4.1
v0.3.30
v0.3.29
v0.3.28
v0.3.27
v0.3.26
v0.3.25
v0.3.24
v0.3.23
v0.3.22
v0.3.21
v0.3.20
v0.3.19
v0.3.18
v0.3.17
v0.3.16
v0.3.15
v0.3.14
v0.3.13
v0.3.12
v0.3.11
v0.3.10
v0.3.9
v0.3.8
v0.3.7
v0.3.6
v0.3.5
v0.3.4
v0.3.3
v0.3.2
v0.3.1
v0.3.0
v0.2.7
v0.2.6
v0.2.5
v0.2.4
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.0.3
v0.0.2
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".
No due date set.
Dependencies
No dependencies set.
Reference: Cordy/Cairn#486
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
can we implement this?
what is the benefit?
what would the User/customer gain?
is it free for us to use or is there some license agreements/pitfalls?
Research findings (September 2026), sources at the bottom. Answers in the order the issue asks them, then the competitor comparison, the licensing map, and a proposed design.
1. Can we implement this?
Yes, and the integration surface is small and well-documented. Collabora Online (COOL) integrates through WOPI — a plain HTTP protocol where Cairn acts as the "WOPI host". Per Collabora's own SDK, COOL depends on only three file operations, all of which map directly onto what Cairn already has:
CheckFileInfo(GET/wopi/files/<id>)Store.Stat+ our locks/holds/read-only →UserCanWriteGetFile(GET/wopi/files/<id>/contents)Store.Openthrough the normal (decrypting) stackPutFile(POST.../contents)Store.Write— quota, holds and read-only enforcement come freePlus: fetch
/hosting/discoveryfrom the COOL server once (it lists which formats it edits and the iframe URL per format), mint a short-lived access token per user+file (signed HMAC — stateless, no new state file, fits the no-DB architecture), and serve an editor page that embeds the COOL iframe. The web UI side is one "Open in <editor>" entry (kebab + preview panel) behind a boot-probe feature flag, exactly the converter (#297) pattern.Anything Cairn must get right beyond the minimum: the external-change detection handshake (
LastModifiedTimein CheckFileInfo/PutFile + answering 409 withCOOLStatusCode: 1010whenX-COOL-WOPI-Timestampmismatches) — this is what protects against a WebDAV/sync client writing the file mid-editing-session; and bypassing download marking (#423) on WOPI GetFile — a marked file saved back through PutFile would bake the forensic mark into the stored original permanently. Both are handler-level details, not architecture.2. What is the benefit / what does the user gain?
3. Is it free? Licensing map (as of 2026)
For us (Swiss Cairn): completely free and clean. The WOPI host is our own code; we ship zero Collabora code. Collabora Online is MPL 2.0, fully open source, "inbound == outbound" — integrating against it via HTTP creates no obligations on Cairn's codebase. Their FAQ explicitly frames integration as the point of the product ("implement WOPI support… we have the documentation to help you"). There's a partner programme if we ever want to resell subscriptions — optional, not required.
For the customer, two editions of the same software:
So the customer decides free-vs-supported; nothing in the integration changes. That's the cleanest licensing story available in this space.
The alternatives, for contrast:
Key architectural fact: all three of the above speak WOPI on the same host-side surface. Build the WOPI host once for Collabora, and ONLYOFFICE (or anything else) becomes a config value later, not a new subsystem.
4. How the competitors implemented it
collaborationservice (Go) implementing WOPI, plus an app-registry mapping MIME types to registered apps ("Open with…" menu, which is what the #488 reference screenshot showed). Config per app:APP_NAME(display name, admin-chosen),APP_PRODUCT(Collabora/OnlyOffice/Microsoft365 — behavioural quirks per product),APP_ADDR(the document server URL),WOPI_SRC(the externally reachable address of the WOPI endpoints — the document server must be able to call back). Their service is off by default because it needs the external document server. Also relevant: they need a token store (NATS/Redis) for short-token support — Cairn's stateless signed-token approach avoids that dependency entirely.richdocumentsapp + Collabora ("Nextcloud Office" is white-labelled Collabora), including a "built-in CODE server" appimage for zero-config small installs. The built-in-server trick is not for us (a gigabyte-plus appimage inside a single Go binary is the opposite of our deployment story); our equivalent convenience is Helm/compose packaging of thecollabora/codecontainer, like the preview converter.5. What we have to take into account (pitfalls)
frame-src/frame-ancestorsCSP both ways, coolwsd's alias-group allowlist (so the COOL server only serves our WOPI host), and awopiBaseconfig override for split-horizon DNS.UserCanWrite: false); PutFile re-enforces server-side regardless. COOL handles concurrent editors internally — our lock is for the WebDAV/desktop world, and the timestamp handshake (above) bridges the two.appName, like OpenCloud) and our UI copy generic ("Open in Collabora Online" when that's the configured name). Referential use of the name is fine per their trademark policy.collabora/codeships multi-arch — dogfoodable on the Pi cluster, though a small x86 LXC would perform better.6. Recommended path
Implement a generic WOPI host with Collabora as the first-class target. Config block
office.url(+appName,wopiBase, optional format list), boot-time discovery fetch →feat.officeprobe → UI entries only when configured — the proven #297 pattern. Phases: (1) backend WOPI host TDD'd against synthetic WOPI calls + token round-trip; (2) editor page + UI entries (mockup first); (3) packaging (Helm optional service, default off, loud docs) + dogfood on the cluster + handbook page. ONLYOFFICE support later = mostly testing + anappProductswitch, if ever needed.Cairn licence gating — options, decision Nikola's:
(a) available in every licensed tier (drives adoption; customer pays Collabora only if they want the supported edition), or
(b) Business-tier feature (it's a collaboration/enterprise capability, and the enforcement hook exists via
feat.lic), or(c) core open in all tiers, with admin-side controls (per-space edit policy, watermarking) as Business features later.
Sources: Collabora SDK — How to integrate (WOPI) · Collabora FAQ (editions, licensing, MPL, subscriptions) · OpenCloud collaboration service docs · ONLYOFFICE 9.4 removes community connection limit · Collabora vs OnlyOffice after the Euro-Office fork (2026) · oCIS app-registry/app-provider docs
Researched by Claude on behalf of @Cordy.
Decisions (Nikola, 2026-09-13):
Issue stays open as the implementation tracker with the research above as the decision record.
Deployment + legal posture addendum (2026-09-13):
Dogfood networking plan (Nikola handles DNS):
code.c0rdyceps.ch→ A84.234.21.80(VPS, standard chain: Caddy → WireGuard → LAN).frame_ancestors= the Cairn origins (files-bao, files), and its alias-group allowlist restricted to our WOPI hosts.Licensing posture (settled):
appNamekeeps UI copy generic); Helm/compose may reference the publiccollabora/codeimage (customer pulls it — same asgotenberg/gotenberg:8today); if Swiss Cairn ever resells Collabora subscriptions or operates it as a managed service, we join their partner programme first — that is the vehicle for it, and an opportunity rather than a risk.Shipped in v0.6.178 (PR #516), live on both dogfoods. Built exactly to the approved office-editor mockup rev 2.
Deployed infrastructure
k3s/collabora/: MetalLB 192.168.10.250, Service 80→9980,ssl.enable=false+ssl.termination=truebehind your Caddy route, aliasgroups for files.c0rdyceps.ch / files-bao.c0rdyceps.ch / 192.168.10.249 (these also feed coolwsd's frame-ancestors, so the iframe is permitted). Discovery verified end-to-end through code.c0rdyceps.ch: 74 edit actions, all six target formats.Backend (witnessed-red TDD,
internal/office+internal/api)/wopi/files/{id}(+/contents) mounted on the OUTER mux beside /login and /s/: CheckFileInfo (UserCanNotWriteRelative— no Save As), GetFile, PutFile. The verified token's user is injected into the request context, so the scoped storage stack resolves paths, per-user encryption keys, quota, holds, locks and read-only spaces exactly as for that user's own session.X-COOL-WOPI-Timestamphandshake (mismatch → 409 +COOLStatusCode: 1010, so external WebDAV/sync changes become an overwrite-or-reload prompt instead of a silent clobber), and GetFile runs undermarks.ContextSkipMarkingso an edit round-trip can never bake a #423 download mark into the stored file./api/v1/office/opendecides write access up front (read-only space / covering lock with owner / legal hold) and states the reason; Recents +office-openaudit on open.POST /api/v1/files/newcreates from templates embedded in the binary (minimal ODF and OOXML built at release; md/txt empty) through the scoped store.office{url, appName, wopiBase}; envCAIRN_OFFICE_URL/CAIRN_OFFICE_WOPI_BASEwin, which is how the dogfoods are configured (GitOps env, config Secrets untouched).Frontend (mockup rev 2, all four variants)
Docs/legal: handbook
document-editing.md(+ index row), EULA "Third-party document servers" clause with the agreed wording, compose + chart notes (default off, browser-facing warning), CHANGELOG v0.6.178.Live verification: both dogfoods report
office editor enabled endpoint=https://code.c0rdyceps.ch app="Collabora Online"at v0.6.178;/wopi/files/*answers 401 on a bad token through the public route (the exact path COOL calls); office probe correctly session-gated.The one check only a signed-in human can do: open a docx on files-bao, watch it render in the editor, type, and confirm the save round-trip. That's yours, champ.