Skip to content
This repository has been archived by the owner on Mar 14, 2019. It is now read-only.

Latest commit

 

History

History
168 lines (115 loc) · 5.11 KB

additional-requirements.rst

File metadata and controls

168 lines (115 loc) · 5.11 KB
Raw

Additional Requirements

Nowadays, RUNALYZE comes with a lot of advanced features that require several micro services. Most of them are required for some special feature only or provide optional enhancements. It's your own responsibility to get them working.

Permissions

The following directories need to be writable:

  • data/cache/
  • data/import/
  • data/log/
  • data/poster/
  • data/sessions/
  • var/cache/
  • var/logs/
  • var/tmp/

Queue

From v4.0 on

As the complexity of RUNALYZE arises, not all requests can be handled within a few seconds. A queueing system is used to process long lasting tasks (e.g. generating a complete backup or fancy posters from all your activities) in background.

To process the queue, you need to create a cronjob for:

php <pathToRunalyze>/bin/console runalyze:queue:consume --env=prod --no-debug (--max-runtime 120) (--max-messages 10) (--stop-when-empty)

Look at the :doc:`commands page <commands>` to see how to execute the service/command.

Parameters:

  • --max-runtime <seconds> Maximum time in seconds the consumer will run.
  • --max-messages <messages> Maximum number of messages that should be consumed.
  • --stop-when-empty Stop consumer when queue is empty.

Always set a maximal runtime, if you use a cronjob.

Even better: Create a systemd service for an always running worker.

Mails

Mails are used for several processes, mainly all account related changes (e.g. registration, changing password, account deletion). The mail server needs to be configured in your data/config.yml (see :doc:`configuration <configuration>`).

Paths to non-php languages

Not all tools that we use are written in php, but the following languages are in general available on common unix systems. You only need to adjust paths in your data/config.yml (see :doc:`configuration <configuration>`) in case of problems.

Perl
Perl is required to parse .fit files from garmin devices (and it is highly recommended to import fit files instead of tcx or similar).
Python
Python (v3.x) is required from v4.0 on to generate svg posters. Install the python dependencies via pip3 install -r vendor/runalyze/GpxTrackPoster/requirements.txt

Non-php tools

Several non-php tools need to be installed locally for optional features.

ttbincnv
Reading ttbin files from TomTom requires an additional tool. A compiled version is available at call/perl/ttbincnv but you may need to compile ryanbinns/ttwach specifically for your system.
rsvg-convert
From v4.0 on, our poster tool requires rsvg-convert to convert svg files to png files.
inkscape
From v4.0 on, our poster tool requires inkscape to convert svg files generated as type circular to png files.

Elevation data from srtm files

Elevation data from gps files is not very accurate. We highly recommend to use satellite data to correct elevation data of your activities. There exist free APIs but it's much faster to use local files.

Respective data can be downloaded via dwtkns. You need to place all relevant *.tif files for your region into data/srtm.

API Keys

We use several APIs for different purposes. API keys and tokens have to be set in your data/config.yml (see :doc:`configuration <configuration>`).

Weather data
Loading weather data automatically is possible via openweathermap.org (free plan offers recent data only) and darksky.net.
Map layer
Additional map layer by Nokia HERE require an API key, see developer.here.com
Elevation data
Elevation data can be retrieved via several services. Local srtm files are recommended, but geonames: geonames.org offers free data as well.

Time zone detection

From v2.5 on

Most activity files do not correctly specify the time zone. Time zone detection can be done based on coordinates but requires a special database and additional php extensions:

Required packages:

  • php-sqlite3
  • sqlite3
  • libsqlite3-mod-spatialite (at least on ubuntu 16.04)

Database file (has to be stored as data/timezone.sqlite:

In addition, you need to set sqlite3.extension_dir in your php.ini to wherever mod_spatialite is located.

Local templates

From v3.0 on, see :doc:`Templates <templates>`

You may overwrite all existing templates (located in app/Resources/views) with local templates in data/views. Still, it's your responsibility to adjust them if base templates change in a new version.

Examplary usages:

  • analytics.html.twig - for some analytics tool like piwik
  • maintenance.html.twig - for maintenance messages