From 84b4cc2c138ae4e959b65fed5c13a72af8a6b207 Mon Sep 17 00:00:00 2001 From: Daniel Friesel <derf@finalrewind.org> Date: Sun, 3 May 2020 13:54:54 +0200 Subject: Update README, add Docker section --- README.md | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 84 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 67579d1..28a4e8a 100644 --- a/README.md +++ b/README.md @@ -9,36 +9,101 @@ It supports most german local transit networks and also some austrian ones. There's a public [vrr-infoscreen service on finalrewind.org](https://vrrf.finalrewind.org/). You can also host your own -instance, see the Setup notes below. +instance via carton/cpanminus or Docker, see the Setup notes below. ## Dependencies - * perl ≥ 5.10 - * Cache::File (part of the Cache module) - * DateTime - * DateTime::Format::Strptime - * File::ShareDir - * GD - * Mojolicious - * Mojolicious::Plugin::BrowserDetect - * Travel::Status::DE::EFA ≥ 1.15 - * Travel::Status::DE::HAFAS ≥ 2.03 - * Travel::Status::DE::URA ≥ 2.01 + * perl ≥ 5.20 + * carton or cpanminus + * build-essential (gcc/clang, make) + * libdb (Berkeley Database Libraries) + * libgd (GD Graphics Library) + * libxml2 + * zlib -## Setup +## Installation + +After installing the dependencies, clone the repository using git, e.g. + +``` +git clone https://git.finalrewind.org/vrr-fakedisplay +``` + +Make sure that all files (including `.git`, which is used to determine the +software version) are readable by your www user, and follow the steps in the +next sections. + +## Perl Dependencies + +vrr-infoscreen depends on a set of Perl modules which are documented in +`cpanfile`. After installing the dependencies mentioned above, you can use +carton or cpanminus to install Perl depenencies locally. + +In the project root directory (where `cpanfile` resides), run either + +``` +carton install +``` + +or + +``` +cpanm -n --installdeps . +``` + +Next, you need to build App::VRR::Fakedisplay, which is required for the lED +frontend and shipped with vrr-fakedisplay. + +``` +perl Build.PL +./Build +./Build manifest +sudo ./Build install +``` -First, build App::VRR::Fakedisplay which is required for the LED frontend: +## Running -* perl Build.PL -* ./Build -* ./Build manifest -* sudo ./Build install +You are now ready to start the web service. If you used carton, it boils +down to + +``` +carton exec hypnotoad index.pl +``` + +Otherwise, you need to make the perl dependencies available by setting the +PERL5LIB environment variable: + +``` +PERL5LIB=local/lib/perl5 local/bin/hypnotoad index.pl +``` + +Note that you should provide imprint and privacy policy pages. Depending on +traffic volume, you may also want to increase the amount of worker processes. +See the Setup notes below. + +## Installation with Docker + +A vrr-infoscreen image is available on Docker Hub. You can install and run it +as follows: + +``` +docker pull derfnull/vrr-fakedisplay:latest +docker run --rm -p 8000:8091 -v "$(pwd)/templates:/app/ext-templates:ro" vrr-fakedisplay:latest +``` + +This will make the web service available on port 8000. Note that you should +provide imprint and privacy policy pages, see the Setup notes below. + +Use `docker run -e VRRFAKEDISPLAY_WORKERS=4 ...` and similar to pass +environment variables to the vrr-infoscreen service. + +## Setup vrr-infoscreen is configured via environment variables: | Variable | Default | Description | | :------- | :------ | :---------- | -| VRRFAKEDISPLAY\_LISTEN | `http://127.0.0.1:8091` | IP and Port for web service | +| VRRFAKEDISPLAY\_LISTEN | `http://*:8091` | IP and Port for web service | | VRRFAKEDISPLAY\_STATS | _None_ | File in which the total count of (non-cached) backend API requests is written | | VRRFAKEDISPLAY\_CACHE | `/tmp/vrr-fakedisplay` | Cache directory | | VRRFAKEDISPLAY\_WORKERS | 2 | Number of concurrent worker processes | -- cgit v1.2.3