summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2025-04-21 16:10:09 +0200
committerBirte Kristina Friesel <derf@finalrewind.org>2025-04-21 16:10:09 +0200
commitd7a9946aa12807da1a2a1c1dd7f31de94f1691bc (patch)
tree3ffbca5fced5a5c6cc78fe53367f6564b4470f37
parent702379414fb037a69a6987a29c9f43f245e94e09 (diff)
README: Debian releases and a Docker image are now available
-rw-r--r--README.md86
1 files changed, 83 insertions, 3 deletions
diff --git a/README.md b/README.md
index b85988b..861ca60 100644
--- a/README.md
+++ b/README.md
@@ -15,12 +15,70 @@ instructions.
You have five installation options:
+* `.deb` releases for Debian-based distributions
+* finalrewind.org APT repository for Debian-based distributions
* Installing the latest release from CPAN
* Installation from source
+* Using a Docker image
-__motis-m__ will be available in your PATH after installation. You can run
-`motis-m --version` to verify this. Documentation is available via `man
-motis-m`.
+Except for Docker, __motis-m__ will be available in your PATH after
+installation. You can run `motis-m --version` to verify this. Documentation is
+available via `man motis-m`.
+
+### Release Builds for Debian
+
+[lib.finalrewind.org/deb](https://lib.finalrewind.org/deb) provides Debian
+packages of all release versions. Note that these are not part of the official
+Debian repository and are not covered by its quality assurance process.
+
+To install the latest release, run:
+
+```
+wget https://lib.finalrewind.org/deb/libtravel-status-motis-perl_latest_all.deb
+sudo apt install ./libtravel-status-motis-perl_latest_all.deb
+rm libtravel-status-motis-perl_latest_all.deb
+```
+
+Uninstallation works as usual:
+
+```
+sudo apt remove libtravel-status-motis-perl
+```
+
+### finalrewind.org APT repository
+
+[lib.finalrewind.org/apt](https://lib.finalrewind.org/apt) provides an APT
+repository with Debian packages of the latest release versions. Note that this
+is not a Debian repository; it is operated under a best-effort SLA and if you
+use it you will have to trust me not to screw up your system with bogus
+packages. Also, note that the packages are not part of the official Debian
+repository and are not covered by its quality assurance process.
+
+To set up the repository and install the latest Travel::Status::MOTIS
+release, run:
+
+```
+curl -s https://finalrewind.org/apt.asc | sudo tee /etc/apt/trusted.gpg.d/finalrewind.asc
+echo 'deb https://lib.finalrewind.org/apt stable main' | sudo tee /etc/apt/sources.list.d/finalrewind.list
+sudo apt update
+sudo apt install libtravel-status-motis-perl
+```
+
+Afterwards, `apt update` and `apt upgrade` will automatically install new
+Travel::Status::MOTIS releases.
+
+Uninstallation of Travel::Status::MOTIS works as usual:
+
+```
+sudo apt remove libtravel-status-motis-perl
+```
+
+To remove the APT repository from your system, run:
+
+```
+sudo rm /etc/apt/trusted.gpg.d/finalrewind.asc \
+ /etc/apt/sources.list.d/finalrewind.list
+```
### Installation from CPAN
@@ -100,3 +158,25 @@ Otherwise (also works with carton):
```
perl -Ilocal/lib/perl5 -Ilib bin/motis-m --version
```
+
+### Running motis-m via Docker
+
+A motis-m image is available on Docker Hub. It is intended for testing
+purposes: due to the latencies involved in spawning a container for each
+motis-m invocation, it is less convenient for day-to-day usage.
+
+Installation:
+
+```
+docker pull derfnull/motis-m:latest
+```
+
+Use it by prefixing motis-m commands with `docker run --rm
+derfnull/motis-m:latest`, like so:
+
+```
+docker run --rm derfnull/motis-m:latest --version
+```
+
+Documentation is not available in this image. Please refer to the
+[online motis-m manual](https://man.finalrewind.org/1/motis-m/) instead.