Add Collabora Online #330708

xzfc · 2024-07-28T18:57:01Z

Description of changes

This PR adds Collabora Online Development Edition (CODE). CODE is a way to run LibreOffice in the browser. Continuation of #329525.

In this PR two things are introduced:

A package collabora-online.
A NixOS module to deploy it.

cc: @7c6f434c

fixes #333457

How to run

This guide will let you run a NixOS VM with Collabora Online and Nextcloud. The purpose is to provide a quick start and to demonstrate that it works, so it's messy and insecure.

Note: I am still yet to figure out how to properly run host-accessible NixOS VMs¹, and not port-forwarded ones. That's why the hostname of the host and the VM should match.

Build VM
Grab this definition of NixOS VM and replace myawesomehostname with the hostname of your host. (the VM and the host should have the same hostname)

vm.nix

{
  myawesomehostname =
    { config, pkgs, ... }:
    {
      services.nextcloud = {
        enable = true;
        hostName = "myawesomehostname";
        config.adminpassFile = "/etc/nextcloud-admin-pass";
        extraApps = {
          inherit (config.services.nextcloud.package.packages.apps) richdocuments;
        };
      };
      environment.etc."nextcloud-admin-pass".text = "a";

      services.collabora-online = {
        enable = true;
        settings = {
          ssl.enable = false;
          ssl.termination = false;
        };
        aliasGroups = [ { host = "http://myawesomehostname"; } ];
      };

      systemd.services.nextcloud-setup-collabora = {
        after = [ "nextcloud-setup.service" ];
        wantedBy = [ "multi-user.target" ];
        path = [ config.services.nextcloud.occ ];
        serviceConfig = {
          Type = "oneshot";
          User = "nextcloud";
          ExecStart = pkgs.writeScript "nextcloud-setup-collabora.sh" ''
            #!${pkgs.runtimeShell}
            nextcloud-occ config:app:set richdocuments disable_certificate_verification --value yes
            nextcloud-occ richdocuments:setup --wopi-url=http://myawesomehostname:9980
          '';
        };
      };

      networking.firewall.enable = false;
      virtualisation = {
        forwardPorts = [
          {
            from = "host";
            guest.port = 80;
            host.port = 80;
          }
          {
            from = "host";
            guest.port = 9980;
            host.port = 9980;
          }
        ];
      };

      system.stateVersion = "24.05";
    };
}

Build it with the following command:

nix-build \
    -I nixpkgs=/path/to/nixpkgs \
    "<nixpkgs/nixos/modules/installer/tools/nixos-build-vms/build-vms.nix>" \
    --argstr networkExpr "$PWD/vm.nix"

Run VM
```
sudo ./result/bin/nixos-run-vms
```
Sudo is required to bind the VM to port 80.
Login
In a browser, go to http://myawesomehostname.
It will prompt you with a login page. Enter root and a.
Create a new document
In the top left corner select "Files", then "+ New", then "New Document". Press "Create".
Click on the newly created document to open it.
The Collabora Online editor should appear.

Things done

Add a 👍 reaction to pull requests you find important.

They should use qemu's -net tap, I guess. ↩

SuperSandro2000

We cannot use freeform settings here?

pkgs/by-name/co/collabora-online/package.nix

SuperSandro2000 · 2024-07-28T22:02:49Z

pkgs/by-name/co/collabora-online/package.nix

+    python3
+    python3.pkgs.lxml
+    python3.pkgs.polib
+    rsync


We should probably build a python env with the modules

Why? This pattern is widely used in nixpkgs: https://github.com/search?q=repo%3ANixOS%2Fnixpkgs+"++python3.pkgs."&type=code
These only used during the build, not in runtime.

SuperSandro2000 · 2024-07-28T22:03:17Z

pkgs/by-name/co/collabora-online/package.nix

+  postPatch =
+    ''
+      cp ${./package-lock.json} ${finalAttrs.npmRoot}/package-lock.json
+      patchShebangs .


Please be a bit more specific than everything. Also we normally place postPatch right after patches and src

pkgs/by-name/co/collabora-online/package.nix

SuperSandro2000 · 2024-07-28T22:04:07Z

pkgs/by-name/co/collabora-online/package.nix

+  postInstall = ''
+    cp etc/ca-chain.cert.pem etc/cert.pem etc/key.pem $out/etc/coolwsd
+  '';


Don't we want to take ca-certs?

WDYM? These self-signed certificates are provided for testing purposes.
In NixOS module, they're enabled by default unless overridden by the user.

SuperSandro2000 · 2024-07-28T22:09:23Z

nixos/modules/services/web-apps/collabora-online.nix

+      mount_namespaces = lib.mkOption {
+        type = lib.types.bool;
+        default = false;
+        description = ''Use mount namespaces instead of coolmount.'';
+      };


Why not use them?

Enabled by default in the updated commit.

nixos/modules/services/web-apps/collabora-online.nix

7c6f434c · 2024-07-28T23:40:24Z

About configuration: can we just keep the defaults for most stuff, then edit whatever overrides in? And probably it would be done NixOS/rfcs#42 style with only a few options defined explicitly but whatever the user puts deep into the structure being used for overrides, too…

7c6f434c · 2024-07-29T16:54:35Z

Also silly question: is it a good idea to add the package first and discuss the configuration generation in a follow-up?

Atemu

The package diff LGTM apart from a few smaller things.

The module though... It's a beast. I don't think it's reasonable to accept such a huge module.

Would it be possible to only pass a subset of options and have the application use the upstream default values on its own?
If that is possible, would it be possible to make this a RFC42-style settings option so that we don't have to declare any options ourselves?
In the docker image, the app takes a few env vars to configure the most important things. Perhaps we could limit the module to those (via RFC42-style env var option) and then give the user the ability to pass a plain config file text. This would significantly slim the module while still providing useful high-level options to the user.

pkgs/by-name/co/collabora-online/package.nix

Atemu · 2024-08-04T09:26:02Z

pkgs/by-name/co/collabora-online/package.nix

+    # Use setcap'd wrappers from the wrappers dir, not from the "application path".
+    + ''
+      substituteInPlace common/JailUtil.cpp --replace-fail \
+        'Poco::Path(Util::getApplicationPath(), "coolmount").toString()' \
+        'std::string("/run/wrappers/bin/coolmount")'
+      substituteInPlace wsd/COOLWSD.cpp --replace-fail \
+        ' forKitPath += "coolforkit";' \
+        ' forKitPath = "/run/wrappers/bin/coolforkit";'
+    ''
+    # In the nix build, COOLWSD_VERSION_HASH becomes the same as COOLWSD_VERSION, e.g. `24.04.3.5`.
+    # The web server that serves files from `/browser/$COOLWSD_VERSION_HASH`, doesn't expect the
+    # hash to contain dots.
+    + ''
+      substituteInPlace wsd/FileServer.cpp --replace-fail \
+        'Poco::RegularExpression gitHashRe("/([0-9a-f]+)/");' \
+        'Poco::RegularExpression gitHashRe("/([0-9a-f.]+)/");' \
+    '';


These should probably be patches.

Honestly, at that length of the pattern (spurious hits are not too likely) I'd say either way is fine (LibreOffice packaging uses a mix, because long substitutions are easier to maintain than patches)

Removed the first change as it's not required if mount_namespaces enabled. (enabled in the NixOS module by default)

Moved the second change to ./fix-file-server-regex.patch.

nixos/modules/services/web-apps/collabora-online.nix

xzfc · 2024-09-09T00:36:50Z

Update:

Bump from 24.04.5-3 to 24.04.6-1. In this version, the new option mount_namespaces is introduced. When enabled, the WSD don't call setcap/suid wrappers, so I've removed the related patches and wrappers from the PR.
The module is now configured using RFC42-style freeform.
Add an update script.

I've considered the following alternative freeform approaches:

Generate coolwsd.xml from scratch. This option assumes that we abandon the default coolwsd.xml.in and write an almost empty one instead. AFAIU, it's not possible to load the default XML and an additional one. I've abandoned the idea because defaults in coolwsd.xml.in are not exactly the same as built-in default values defined in COOLWSD.cpp despite the comment saying the opposite.
Keep the default coolwsd.xml and let the user configure command line options through extraOptions. E.g. extraOptions = [ "--o:ssl.enable=false" "--o:ssl.termination=false" ];. Drawbacks are described in RFC-42.
Keep the default coolwsd.xml and let the user configure options through freeform, and convert it into command line options. It's get a bit complicated when we have to deal with arrays and XML attributes.
Implemented in this PR: Merge the values from freeform config into the default coolwsd.xml.in. It is done by converting coolwsd.xml into JSON, then merging it with freeform values using jq, then converting it back to XML.

ambroisie · 2024-09-09T07:15:04Z

defaults in coolwsd.xml.in are not exactly the same as built-in default values defined in COOLWSD.cpp despite the comment saying the opposite.

This should probably be reported upstream, even if you already implemented a workaround.

ambroisie · 2024-09-09T07:16:37Z

nixos/modules/services/web-apps/collabora-online.nix

+        <host>::1</host>
+      </post_allow></net>
+      ```
+      in `coolwsd.xml`, or `--o:net.post_allow.host[0]='127\.0\.0\.1 --o:net.post_allow.host=::1` in


I'm assuming this should be:

Suggested change

in `coolwsd.xml`, or `--o:net.post_allow.host[0]='127\.0\.0\.1 --o:net.post_allow.host=::1` in

in `coolwsd.xml`, or `--o:net.post_allow.host[0]='127\.0\.0\.1 --o:net.post_allow.host[1]=::1` in

ambroisie · 2024-09-09T07:18:57Z

nixos/modules/services/web-apps/collabora-online.nix

+  options.services.collabora-online = {
+    enable = lib.mkEnableOption "collabora-online";
+
+    package = lib.mkPackageOption pkgs "collabora-online" { };


Suggested change

package = lib.mkPackageOption pkgs "collabora-online" { };

package = lib.mkPackageOption pkgs "Collaborate Online" { default = "collabora-online"; };

Minion3665 · 2024-09-09T08:54:49Z

defaults in coolwsd.xml.in are not exactly the same as built-in default values defined in COOLWSD.cpp despite the comment saying the opposite.

This should probably be reported upstream, even if you already implemented a workaround.

(!!) yes, please report this, thanks!

xzfc · 2024-09-14T21:27:21Z

defaults in coolwsd.xml.in are not exactly the same as built-in default values defined in COOLWSD.cpp despite the comment saying the opposite.

This should probably be reported upstream, even if you already implemented a workaround.

Reported upsteam: CollaboraOnline/online#10049.

github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: documentation This PR adds or changes documentation 8.has: changelog 8.has: module (update) This PR changes an existing module in `nixos/` labels Jul 28, 2024

xzfc force-pushed the collabora branch from f63874f to 338c353 Compare July 28, 2024 19:35

h7x4 added the 8.has: module (new) This PR adds a module in `nixos/` label Jul 28, 2024

ofborg bot added 8.has: package (new) This PR adds a new package 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Jul 28, 2024

SuperSandro2000 reviewed Jul 28, 2024

View reviewed changes

drupol mentioned this pull request Aug 3, 2024

Collabora #308151

Closed

13 tasks

drupol requested a review from Minion3665 August 3, 2024 19:49

Atemu reviewed Aug 4, 2024

View reviewed changes

collabora-online: init at 24.04.6-1

3217f4a

xzfc force-pushed the collabora branch 2 times, most recently from 33ce05d to 91a524a Compare September 8, 2024 23:13

ambroisie reviewed Sep 9, 2024

View reviewed changes

nixos/collabora-online: init

afb0b0e

xzfc force-pushed the collabora branch from 91a524a to afb0b0e Compare September 14, 2024 21:25

7c6f434c merged commit c87aad4 into NixOS:master Sep 27, 2024
27 checks passed

amalgame21 mentioned this pull request Oct 8, 2024

Package request: Collabora Online Development Edition & Nextcloud support #218878

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Collabora Online #330708

Add Collabora Online #330708

xzfc commented Jul 28, 2024 •

edited

Loading

SuperSandro2000 left a comment

SuperSandro2000 Jul 28, 2024

xzfc Sep 8, 2024

SuperSandro2000 Jul 28, 2024

xzfc Sep 8, 2024

SuperSandro2000 Jul 28, 2024

xzfc Sep 8, 2024

SuperSandro2000 Jul 28, 2024

xzfc Sep 8, 2024

7c6f434c commented Jul 28, 2024

7c6f434c commented Jul 29, 2024

Atemu left a comment

Atemu Aug 4, 2024

7c6f434c Aug 7, 2024

xzfc Sep 8, 2024

xzfc commented Sep 9, 2024

ambroisie commented Sep 9, 2024

ambroisie Sep 9, 2024

xzfc Sep 14, 2024

ambroisie Sep 9, 2024

xzfc Sep 14, 2024

Minion3665 commented Sep 9, 2024

xzfc commented Sep 14, 2024

	in `coolwsd.xml`, or `--o:net.post_allow.host[0]='127\.0\.0\.1 --o:net.post_allow.host=::1` in
	in `coolwsd.xml`, or `--o:net.post_allow.host[0]='127\.0\.0\.1 --o:net.post_allow.host[1]=::1` in

	package = lib.mkPackageOption pkgs "collabora-online" { };
	package = lib.mkPackageOption pkgs "Collaborate Online" { default = "collabora-online"; };

Add Collabora Online #330708

Add Collabora Online #330708

Conversation

xzfc commented Jul 28, 2024 • edited Loading

Description of changes

How to run

Things done

Footnotes

SuperSandro2000 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

7c6f434c commented Jul 28, 2024

7c6f434c commented Jul 29, 2024

Atemu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xzfc commented Sep 9, 2024

ambroisie commented Sep 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Minion3665 commented Sep 9, 2024

xzfc commented Sep 14, 2024

xzfc commented Jul 28, 2024 •

edited

Loading