PathLMS 0.119.0
Installing this
Download the files below into one empty directory and follow INSTALL.md. You need Docker and nothing else: no copy of the source code, no git, and no Node.
| File | What it is |
|---|---|
| docker-compose.yml | The whole stack, encryption included. One file, one command. |
| pathlms.env | Your settings, with this release's images already named. |
| INSTALL.md | Numbered steps, from nothing to signed in. |
| rollback.sh | Keep it beside the others. It puts this system back on the version it was running before the last upgrade. Run it as: bash rollback.sh |
| restore-files.sh | Keep it beside the others. It reads a file backup back to prove it is usable, and puts the uploaded files back when they have been lost. Run it as: bash restore-files.sh --verify |
| check-my-settings.sh | Reads your two files and says whether they will work, BEFORE you start anything. It catches the mistakes people make pasting settings into a text box: two settings on one line, the same setting written twice, the address left commented out, image addresses that disagree about the version, a settings file under the wrong name, and an administrator password too short to create an account. Run it as: bash check-my-settings.sh |
| collect-deploy-evidence.sh | Writes one file describing what this installation is actually doing: versions, where the data lives, whether the backups exist, how it is reached, which ports are open. It sends nothing anywhere and prints no password or key. Run it as: bash collect-deploy-evidence.sh |
If your machine is one of these
Some kinds of server decide one or two things their own way. There is a page for each of those below. Download the one that applies to you and read it beside INSTALL.md; it says what is different and sends you back there for everything else.
| Page | For |
|---|---|
| UNRAID.md | Unraid, where a stack of containers needs a Compose plugin and the data has to go on the right storage. |
| BEHIND-A-PROXY.md | A deployment with nginx, Caddy or a load balancer in front holding the certificate, which needs one setting here and a few lines there. |
| CHANGING-THE-PORT.md | Anybody moving the port people arrive on, and anybody whose deployment did not come back on the new one. Keep it on the server: its recovery half is written to be read when no screen is reachable. |
| WHY-THE-COMPOSE-FILE-IS-LIKE-THIS.md | Why a line in docker-compose.yml is the way it is, service by service. The compose file carries what you need while editing; this carries the reasoning behind it. |
Upgrading an existing installation
Change these three lines in your settings file and run docker compose up -d. The product can also do it for you, taking a backup first and putting everything back if anything fails.
One thing to know before you upgrade into this release. This version opens a second port, 3443, for encrypted connections, so that turning encryption on needs nothing but a certificate you make or paste in on the Settings screen. If something else on your machine already uses 3443, Docker refuses to start and says so, naming the port. Put a free one in PATHLMS_PUBLISHED_TLS_PORT in your settings file and start again.
If something in front of this system holds your certificate and you would rather that port were not reachable from outside, set PATHLMS_PUBLISHED_TLS_ADDRESS to 127.0.0.1: including the colon.
PATHLMS_API_IMAGE=ghcr.io/path-lms/api@sha256:fd4c970486a0dc97be0529ab5cdbc5e94fb1b742b6149a1b741457f1406357d2
PATHLMS_WEB_IMAGE=ghcr.io/path-lms/web@sha256:e8e0fc0f02ad32055bed64590d928d322ac2589535bf794d8e78b5c83ae0f13a
PATHLMS_DB_IMAGE=ghcr.io/path-lms/db@sha256:0e7d3b3dd14e0a87db46a0774270fbe47dee467458f627556ce4ae8baad7b4a8
What is published
Three container images and the files above. No source code: the two source archives on this page are added by GitHub itself and hold nothing.