Seafile WebDAV extension (dependencies, package, and integration to seafile service) #171878

flyx · 2022-05-06T23:14:39Z

Description of changes

This adds the Python library seafobj and the Python WSGI application seafdav, both of which belong with the Seafile server. Version is 8.0.8 which is not the most recent one, but conforms to the current versions of existing seafile-server and seahub packages.

seafdav provides a WebDAV interface to a running seafile-server. seafobj is a dependency of seafdav.

The nixos/seafile service has been extended to provide options for automatically starting the WebDAV extension alongside the server. I opted to not allow freeform settings since the existing settings are already confusing – some are consumed by seafdav itself, some by the script server_cli (which my setup doesn't use), and some only when using Seafile's own management script seafile.sh (which isn't viable for NixOS). I wanted to clearly communicate which values are actually relevant.

I reviewed the relevant code (mainly server_cli.py) to learn how the settings are used, and then added and used a simpler WSGI application setup script for the service setup. This enables a service setup very similar to the one of seahub, which also is a WSGI application. This should be easier to maintain than running the server_cli.py script provided from upstream.

Things done

ping @schmittlauch @greizgh (maintainers of the other Seafile packages)

pbsds

Impressive PR for a first-time contributor! Sorry for the long wait, this is not normal. Do not be discouraged!

The diff LGTM, but i have not test-run the package.

Could you please consider adding a nixos test for this module? Something as simple as a test that pings the webdav port should be sufficient.
here is an example

pbsds · 2022-08-06T21:54:18Z

pkgs/applications/networking/seafdav/default.nix

+    sha256 = "1gpvmfamjbw90gh9njgmba58qnzxji1w1sra46spnhi9k778mds3";
+  };
+
+  dontBuild = true;


Please add a comment justifying this.

pbsds · 2022-08-06T21:57:02Z

pkgs/development/python-modules/seafobj/default.nix

+    sha256 = "0jwgbx083mwwh18x7450igq748bbld9s7zgibwv1cxwrrny1aari";
+  };
+
+  dontBuild = true;


Please add a comment justifying this.

pbsds · 2022-08-06T21:57:48Z

pkgs/development/python-modules/seafobj/default.nix

+  src = fetchFromGitHub {
+    owner = "haiwen";
+    repo = "seafobj";
+    rev = "v8.0.8-server";


Suggested change

rev = "v8.0.8-server";

rev = "v${version}-server";

pbsds · 2022-08-06T21:57:58Z

pkgs/development/python-modules/seafobj/default.nix

+, nose
+, python
+}:
+buildPythonPackage {


Suggested change

buildPythonPackage {

buildPythonPackage rec {

pbsds · 2022-08-06T21:59:23Z

pkgs/development/python-modules/seafobj/default.nix

+
+  installPhase = ''
+    runHook preInstall
+    dest="$out/lib/${python.libPrefix}/site-packages"


something like this should exist:

Suggested change

dest="$out/lib/${python.libPrefix}/site-packages"

dest="$out/${python.sitePackages}"

Consider inlining it instead of using a variable.

pbsds · 2022-08-06T22:03:25Z

pkgs/applications/networking/seafdav/default.nix

+  src = fetchFromGitHub {
+    owner = "haiwen";
+    repo = "seafdav";
+    rev = "v8.0.8-server";


Suggested change

rev = "v8.0.8-server";

rev = "v${version}-server";

pbsds · 2022-08-06T22:50:12Z

Result of nixpkgs-review pr 171878 run on x86_64-linux 1

2 packages blacklisted:

nixos-install-tools
tests.nixos-functions.nixos-test

flyx · 2022-08-08T20:32:12Z

@pbsds Thanks for the review. I addressed your comments. Since Seafile has already a test, I simply added WebDAV subtests to it. Testing those showed that I forgot adding my packages to top-level, which I fixed. Running the test runs into an error in the seahub part (missing module 'drafts') and I haven't been able to figure out why, but perhaps I am simply running the test the wrong way…

greizgh

re: testing, draft error sounds like #173825. Make sure you rebase to get the fix.

greizgh · 2022-08-09T19:20:55Z

nixos/modules/services/networking/seafile.nix

+        requires = [ "seaf-server.service" ];
+        restartTriggers = [ seahubSettings ];
+        environment = {
+          PYTHONPATH = "${pkgs.seafdav.pythonPath}:${pkgs.seafdav}:/etc/seafile";


Do we need /etc/seafile in pythonpath?

Suggested change

PYTHONPATH = "${pkgs.seafdav.pythonPath}:${pkgs.seafdav}:/etc/seafile";

PYTHONPATH = "${pkgs.seafdav.pythonPath}:${pkgs.seafdav}";

This is required for loading the seahub_settings.py which is processed by SeafDAV. From what I understand, this is handled via django settings for actual seahub, but that is not used in SeafDAV so I'm unsure whether there's a better way to do this.

greizgh · 2022-08-09T19:23:16Z

pkgs/applications/networking/seafdav/default.nix

+  src = fetchFromGitHub {
+    owner = "haiwen";
+    repo = "seafdav";
+    rev = "v${version}-server";


Upstream has a habit of pushing over existing tags, on other seafile component we end up using commit hashes.
Let's hope this is not the case here 🤞

greizgh · 2022-08-09T19:24:04Z

pkgs/applications/networking/seafdav/default.nix

+}:
+python3.pkgs.buildPythonApplication rec {
+  pname = "seafdav";
+  version = "8.0.8";


seafile-server has been updated to 9.0.x, maybe update this component too?

Yes now that the other packages have been updated this should be too. I pushed the 9.0.7 version.

Python module required for the Seafile WebDAV extension

WebDAV extension for Seafile server. Package adds a WSGI application for easy deployment, which is lacking from upstream sources.

Added option to start the optional WebDAV service alongside a Seafile server. Added options for configuring the WebDAV service. Added subtests for WebDAV server to Seafile test.

flyx · 2022-08-10T20:14:48Z

@greizgh Did a rebase and the error vanished, but test still fails with a timeout on starting seahub. Might be that my machine is simply too slow.

greizgh · 2022-12-03T08:53:11Z

@greizgh Did a rebase and the error vanished, but test still fails with a timeout on starting seahub. Might be that my machine is simply too slow.

Tests were flaky because of sleep conditions, it should be fixed by #195253.

ddelabru · 2023-01-13T19:49:10Z

This addresses the same functionality as #152069 but at present it looks like this one is the more complete pull request.

hustlerone · 2025-03-04T07:06:44Z

So... What's keeping this from being merged?

flyx · 2025-03-04T12:27:10Z

So... What's keeping this from being merged?

I lost interest in pushing this to get merged due to the long process. I just integrated it as local overlay on my system.

For the PR to be merged the seafobj/seafdav version should be updated (server and seahub have been bumped to 11.0.12 on nixos stable & unstable). Not sure whether this requires additional changes. In any case, I won't be doing it since the newer Seafile versions dropped support for postgres, which make me rather want to switch to an alternative than to upgrade.

Feel free to adopt the PR.

hustlerone · 2025-03-06T16:22:19Z

Nextcloud isn't any better hence my interest

flyx requested review from FRidh and jonringer as code owners May 6, 2022 23:14

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

ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels May 7, 2022

pbsds requested changes Aug 6, 2022

View reviewed changes

flyx force-pushed the seafdav branch 7 times, most recently from 099c4d7 to a60e225 Compare August 8, 2022 20:28

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: 1-10 and removed 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin labels Aug 8, 2022

greizgh reviewed Aug 9, 2022

View reviewed changes

maintainers: add flyx

695845a

flyx force-pushed the seafdav branch from a60e225 to 8214578 Compare August 10, 2022 19:41

flyx added 3 commits August 10, 2022 22:08

seafobj: init at 9.0.7

45ed435

Python module required for the Seafile WebDAV extension

seafdav: init at 9.0.7

6fa5ee6

WebDAV extension for Seafile server. Package adds a WSGI application for easy deployment, which is lacking from upstream sources.

nixos/seafile: support running WebDAV extension

1882cdb

Added option to start the optional WebDAV service alongside a Seafile server. Added options for configuring the WebDAV service. Added subtests for WebDAV server to Seafile test.

flyx force-pushed the seafdav branch from 8214578 to 1882cdb Compare August 10, 2022 20:08

Janik-Haag added the 12. first-time contribution This PR is the author's first one; please be gentle! label Jun 12, 2023

wegank added 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 2.status: merge conflict This PR has merge conflicts with the target branch labels Mar 19, 2024

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 20, 2024

wegank added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jul 4, 2024

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 4, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Seafile WebDAV extension (dependencies, package, and integration to seafile service) #171878

Seafile WebDAV extension (dependencies, package, and integration to seafile service) #171878

flyx commented May 6, 2022

pbsds left a comment •

edited

Loading

pbsds Aug 6, 2022

pbsds Aug 6, 2022

pbsds Aug 6, 2022

pbsds Aug 6, 2022

pbsds Aug 6, 2022

pbsds Aug 6, 2022

pbsds commented Aug 6, 2022

flyx commented Aug 8, 2022 •

edited

Loading

greizgh left a comment

greizgh Aug 9, 2022

flyx Aug 10, 2022

greizgh Aug 9, 2022

greizgh Aug 9, 2022

flyx Aug 10, 2022

flyx commented Aug 10, 2022

greizgh commented Dec 3, 2022

ddelabru commented Jan 13, 2023

hustlerone commented Mar 4, 2025

flyx commented Mar 4, 2025

hustlerone commented Mar 6, 2025

	dest="$out/lib/${python.libPrefix}/site-packages"
	dest="$out/${python.sitePackages}"

	PYTHONPATH = "${pkgs.seafdav.pythonPath}:${pkgs.seafdav}:/etc/seafile";
	PYTHONPATH = "${pkgs.seafdav.pythonPath}:${pkgs.seafdav}";

Seafile WebDAV extension (dependencies, package, and integration to seafile service) #171878

Are you sure you want to change the base?

Seafile WebDAV extension (dependencies, package, and integration to seafile service) #171878

Conversation

flyx commented May 6, 2022

Description of changes

Things done

pbsds left a comment • edited Loading

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

pbsds commented Aug 6, 2022

flyx commented Aug 8, 2022 • edited Loading

greizgh 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

flyx commented Aug 10, 2022

greizgh commented Dec 3, 2022

ddelabru commented Jan 13, 2023

hustlerone commented Mar 4, 2025

flyx commented Mar 4, 2025

hustlerone commented Mar 6, 2025

pbsds left a comment •

edited

Loading

flyx commented Aug 8, 2022 •

edited

Loading