pmtiles-swarm 0.44.0 → 0.45.1

package/CHANGELOG.md

@@ -7,6 +7,34 @@
 ### 🐞 Bug fixes
 - _...Add new stuff here..._
 
+## 0.45.1
+### ✨ Features and improvements
+
+### 🐞 Bug fixes
+- **The virtualenv route for libtorrent now says it can hand you an older version.** pip installs the
+  newest wheel the *Python* can take, not the newest libtorrent, and the wheels for Python 3.8 stop
+  at 2.0.9 — so on Ubuntu 20.04 the recipe as written produced a downgrade from the distribution's
+  own package, silently. The section now says how to read the `cp` tag in the filename, to compare
+  both interpreters before committing, and that a newer libtorrent on an older release needs a newer
+  Python first.
+
+## 0.45.0
+### ✨ Features and improvements
+- **Requires pmtiles-torrent 0.9.1**, which stops the sidecar rewriting resume data that has not
+  changed. A hybrid torrent carries a merkle tree of 32 bytes per 16 KiB block in its resume data —
+  a few hundred megabytes for a 128 GiB archive — and it was being restaged, fsynced and renamed
+  every five minutes for every archive at once, to record that nothing had moved. It also gives each
+  torrent its own share of the save budget instead of five seconds for the whole library, which is
+  why a node with four archives persisted two of them and a different two next time.
+- **Running as a service documents a newer libtorrent than the distribution ships.** `apt` gives you
+  whatever your release froze on, `pip install` into the system Python is refused under PEP 668, and
+  `--break-system-packages` is not the way round it. A virtualenv plus the existing
+  `libtorrent.python` key is, reversibly and without touching apt. The upgrade section now also says
+  that libtorrent is a third thing an update never moves, and how to check which one the service
+  actually imports.
+
+### 🐞 Bug fixes
+
 ## 0.44.0
 ### ✨ Features and improvements
 - **Web seeds are added where they are listed.** The **HTTP sources** tab now has a field and an Add

package/docs/running-as-a-service.md

@@ -553,6 +553,52 @@ rather than exiting. Name the interpreter explicitly when the service user's
 { "libtorrent": { "python": "/usr/bin/python3" } }
 ```
 
+### A newer libtorrent than the distribution ships
+
+`apt` gives you whatever your release froze on, which on Ubuntu 24.04 is
+libtorrent 2.0.x. `pip install libtorrent` into the system Python is refused —
+`externally-managed-environment`, because apt owns that Python — and
+`--break-system-packages` is not the way round it.
+
+Give the service account a virtualenv instead and point the sidecar at it. The
+same `python` key does the work, so nothing else changes:
+
+```sh
+sudo -u pmtiles-swarm python3 -m venv /var/lib/pmtiles-swarm/venv
+sudo -u pmtiles-swarm /var/lib/pmtiles-swarm/venv/bin/pip install libtorrent
+sudo -u pmtiles-swarm /var/lib/pmtiles-swarm/venv/bin/python   -c "import libtorrent; print(libtorrent.__version__)"
+```
+
+```json
+{ "libtorrent": { "python": "/var/lib/pmtiles-swarm/venv/bin/python" } }
+```
+
+**Check what you got before pointing anything at it.** pip installs the newest
+wheel _your Python_ can take, which is not the newest libtorrent. The filename
+says which: `libtorrent-2.1.1-cp312-…` is Python 3.12, `libtorrent-2.0.9-cp38-…`
+is Python 3.8 — and 2.0.9 is where the wheels for 3.8 stop. On Ubuntu 20.04,
+whose `python3` is 3.8, this route hands you something **older** than the
+distribution's own package. Compare the two before you commit to it:
+
+```sh
+sudo -u pmtiles-swarm python3 -c "import libtorrent; print(libtorrent.__version__)"
+sudo -u pmtiles-swarm /var/lib/pmtiles-swarm/venv/bin/python   -c "import libtorrent; print(libtorrent.__version__)"
+```
+
+If the venv is not newer, delete it and keep the distribution package. Getting a
+newer libtorrent on an older release means a newer Python first — deadsnakes, or
+the release upgrade — and building the venv from that interpreter.
+
+Reversible in one line: delete the key and the node is back on the distribution
+package, with no uninstall and nothing done to apt. `ReadWritePaths` already
+covers `/var/lib/pmtiles-swarm`, so the venv needs no unit change — put it
+anywhere else and it does.
+
+Worth doing for a node seeding very large hybrid archives, where v2 support has
+had the most work since 2.0. Change one thing at a time, though: take a version
+of the node first, confirm what it did, then move libtorrent, so a difference in
+behaviour has one candidate rather than two.
+
 ## Ports
 
 Five listeners, and only the peer ports want a firewall rule. See
@@ -615,6 +661,22 @@ sudo -u pmtiles-swarm -H npm ls --prefix /var/lib/pmtiles-swarm --depth 1 \
   pmtiles-swarm pmtiles-torrent
 ```
 
+**libtorrent itself is a third thing, and an update never touches it.** The
+sidecar is Python that ships with the package; libtorrent is the binding it
+imports, which came from `apt` or from a virtualenv you made. Neither moves when
+the node does:
+
+```sh
+sudo -u pmtiles-swarm python3 -c "import libtorrent; print(libtorrent.__version__)"
+```
+
+Run that against whatever `libtorrent.python` names, not your login shell's
+Python — they are frequently different interpreters, and the one that matters is
+the one the service uses. See
+[a newer libtorrent than the distribution ships](#a-newer-libtorrent-than-the-distribution-ships)
+for moving it, and move it on its own: a node upgrade and a libtorrent upgrade in
+one restart leaves two candidates for whatever happens next.
+
 An install runs the dependency install scripts again, so check WebRTC survived
 it — see [the allowScripts warning](#the-allowscripts-warning):
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmtiles-swarm",
-  "version": "0.44.0",
+  "version": "0.45.1",
   "description": "BitTorrent distribution for PMTiles map archives: create torrents, watch folders, publish and subscribe to RSS feeds, and seed through qBittorrent or an embedded client",
   "type": "module",
   "main": "src/index.js",
@@ -46,7 +46,7 @@
     "maplibre-gl": "^6.2.0",
     "parse-torrent": "^11.0.24",
     "pmtiles": "^4.4.1",
-    "pmtiles-torrent": "^0.9.0",
+    "pmtiles-torrent": "^0.9.1",
     "webtorrent": "^3.0.21"
   },
   "engines": {