diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 23 insertions, 11 deletions
@@ -1,10 +1,9 @@ db-infoscreen - App/Infoscreen for Railway Departures in Germany --- -[db-infoscreen homepage](https://finalrewind.org/projects/db-fakedisplay/) - -db-infoscreen (formerly db-fakedisplay) shows departures at german train -stations, serving both as infoscreen / webapp and station board look-alike. +[db-infoscreen](https://finalrewind.org/projects/db-fakedisplay/) (formerly +db-fakedisplay) shows departures at german train stations, serving both as +infoscreen / webapp and station board look-alike. It aims to aggregate departure and train data from different sources and combine them in a useful (and user-friendly) manner. It is intended both for a @@ -90,13 +89,12 @@ re-start the container. Setup --- -db-infoscreen respects the following environment variables: +In hypnotoad mode (recommended), db-infoscreen respects the following environment variables: | Variable | Default | Description | | :------- | :------ | :---------- | | DBFAKEDISPLAY\_LISTEN | `http://*:8092` | IP and Port for web service | | DBFAKEDISPLAY\_STATS | _None_ | File in which the total count of backend API requests (excluding those answered from cache) is written | -| DBFAKEDISPLAY\_HAFAS\_API | `https://v5.db.transport.rest` | hafas-rest-api endpoint | | DBFAKEDISPLAY\_IRIS\_CACHE | `/tmp/dbf-iris-mian` | Directory for IRIS schedule cache | | DBFAKEDISPLAY\_IRISRT\_CACHE | `/tmp/dbf-iris-realtime` | Directory for IRIS realtime cache | | DBFAKEDISPLAY\_WORKERS | 2 | Number of worker processes (i.e., maximum amount of concurrent requests) | @@ -106,10 +104,15 @@ Set these as needed, create `templates/imprint.html.ep` (imprint) and pass requests for db-infoscreen to the appropriate port. See the `examples` directory for imprint and privacy policy samples. -You can run the app using a Mojo::Server of your choice, e.g. **perl -index.pl daemon -m production** (quick&dirty, does not respect all variables) -or **hypnotoad** (recommended). A systemd unit example is provided in -`examples/db-infoscreen.service`. +You can then use a service supervisor of your choice to run **hypnotoad index.pl** +(using Mojolicious' hypnotoad server). See `examples/db-infoscreen.service` +for a systemd unit example. + +For a quick&dirty setup on low-traffic sites you can also use **morbo index.pl** +or **perl index.pl daemon -m production**. In this case, DBFAKEDISPLAY\_LISTEN +and DBFAKEDISPLAY\_WORKERS have no effect. Morbo accepts IP and port +configuration using the `-l`/`--listen` switch (default: `http://*:3000`); +Daemon mode respects the MOJO\_LISTEN environment variable (default: `http://*:3000`). For public-facing installations, you may want to enable caching in the reverse proxy serving DBF. See `examples/nginx-cache.conf` and @@ -122,7 +125,7 @@ see the respective files) licenses. Attribution is appreciated. Background Data Updates --- -db-infoscreen can use <https://lib.finalrewind.org/dbdb/db_zugbildung_v0.json> +db-infoscreen can use <https://lib.finalrewind.org/dbdb/db_zugbildung_v1.json> 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`. @@ -166,3 +169,12 @@ The easiest way of making changes available is by maintaining a public fork of the Git repository. A tarball is also acceptable. Please change `source_url` in `lib/DBInfoscreen.pm` to point to your Git repository / source archive if you are using a version with custom changes. + +Resources +--- + +Mirrors of the db-infoscreen repository are available at + +* [Chaosdorf](https://chaosdorf.de/git/derf/db-infoscreen) +* [git.finalrewind.org](https://git.finalrewind.org/db-fakedisplay/) +* [GitHub](https://github.com/derf/db-fakedisplay) |