From 59d74f1429281bfdf8e10447d649050c757a9b8e Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sat, 16 Jan 2021 10:34:48 +0100 Subject: Document zugbildungsplan.json source --- README.md | 17 +++++++++++++++++ examples/dbf_update_zugbildungsplan | 9 +++++++++ 2 files changed, 26 insertions(+) create mode 100644 examples/dbf_update_zugbildungsplan diff --git a/README.md b/README.md index 64bf760..2100d8e 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,23 @@ All code in this repository may be used under the terms of the BSD-2-Clause (db-infoscreen, see COPYING) and MIT (jquery, jqueryui, and marquee libraries; see the respective files) licenses. Attribution is appreciated. +Background Data Updates +--- + +db-infoscreen can use +to show scheduled ICE/IC types (ICE 1/2/3/4/T, IC 1/2), wagon orders, and other +attributes. It expects the file to be provided in `share/zugbildungsplan.json`. + +As this information is updated regularly, the file is not shipped as part of +this db-infoscreen distribution. It is recommended to retrieve it a few minutes +after midnight via a daily cronjob. See `examples/dbf_update_zugbildungsplan` +for a shell script. + +DBF will periodically reload `share/zugbildungsplan.json`. You can use your +service supervisor (e.g. `systemctl reload db-infoscreen`) to force an +immediate reload. You may also ignore the file entirely; it is entirely +optional. + System requirements --- diff --git a/examples/dbf_update_zugbildungsplan b/examples/dbf_update_zugbildungsplan new file mode 100644 index 0000000..816495e --- /dev/null +++ b/examples/dbf_update_zugbildungsplan @@ -0,0 +1,9 @@ +#!/bin/sh + +set -eu + +wget -qO share/zugbildungsplan.json.new https://lib.finalrewind.org/dbdb/db_zugbildung_v0.json + +chmod 644 share/zugbildungsplan.json.new + +mv share/zugbildungsplan.json.new share/zugbildungsplan.json -- cgit v1.2.3