runalyze / admin-docs

RUNALYZE Administration documentation

RUNALYZE docs for admins/developers

Repository for docs.runalyze.com, feel free to contribute.

admin-docs's Issues

Explanation for every configuration value

e.g. encryption (mail) - possible values (tls, ssl...)

OpenWeatherMap-API Key - How to get one...

• How to get one
• Normale API Key is without historical data

Add to list of supported devices

• wahoofitness

Commands: clear cache

Wanted to state that in a current forum thread, but it's not stated in our docs ... (and for the moment I'm too lazy for googling ;))

Irritating update-notification for DB-credentials

In the "update success"-message it says:

Du musst das Skript refactor-night.php ausführen. Bitte trage deine Datenbank-Verbindung in der Datei ein und rufe sie danach über die Konsole oder in deinem Browser auf.

But that file is already using the config.php (line 33):
include_once 'data/config.php';

I'd prefer this inclusion anyway for future DB-refactoring anyway - but still the message is wrong.

Explain how to start queue

• mention the command
• state this in update instructions for v4.0
• state this in installation instructions
• add --env=prod --no-debug to command details
• list command in commands.rst

runalyze:queue:consume (listens on all available queues)

moved from Runalyze/docs#13

How to compile js / css files

Currently, there's no documentation that lessc and yuicompressor-2.4.8.jar are required to run php build/build.php js, php build/build.php css or php build/build.php.

• npm install -g less
• https://github.com/yui/yuicompressor/releases/download/v2.4.8/yuicompressor-2.4.8.jar

Add Perl info to installation guide

Ubuntu 16.04 libsqlite3-mod-spatialite needed

mod-spatialite in Ubuntu 16.04

In Ubuntu 16.04 (and other distros?) install package
libsqlite3-mod-spatialite and use
define('SQLITE_MOD_SPATIALITE', 'mod_spatialite.so');

New config variable: backup_storage_period

Added in Runalyze/Runalyze@c04ef54

Add hint for "Group by" problem with mysql-5.7

Explain new variables for data.php from 2.4 forward

To prevent PHP Notice: Undefined variable: port in /home/kellercl/public_html/runalyze/inc/class.Installer.php on line 167 the admin-documentation should be updated to mention that the config.php needs a $port for the database (which can be left '' if there ain't one).

Especially helpul for already running (self-) installations that want to update.
Or put an example into the new config-folder.

by @rob-st

Docs for feature/micro-symfony

As we're planning to switch to Symfony and trying to use some kind of micro controllers in the current feature/micro-symfony we have to be good at documenting what's changing for admins and how they can solve potential issues.

• Symfony needs write permissions for
  • app/logs
  • app/cache/dev
  • app/cache/prod
• How to use the new web/ directory?
  • How to configure the server (if necessary)?
  • Can someone just run it as localhost/runalyze/web/?
  • How are update/install/refactor scripts working?

New configuration option: thunderforest_api_key

Add thunderforest_api_key
Runalyze/Runalyze@ed657a0

Ubuntu/debian installation

packages / instructions to install dependencies for poster tool:

• python3
• python3-pip
• pip3 install -r vendor/runalyze/GpxTrackPoster/requirements.txt

Update docs for 3.1

Add config var "forecastio_api_key" -> https://github.com/Runalyze/Runalyze/issues/1942

How to add and where to find the srtm files

Download zip files for needed regions: http://dwtkns.com/srtm/
Unzip in data/srtm

Explain requirements for poster tool

Requirements:

• python3
• rsvg[-convert]

Configuration:

• python3_path: /usr/bin/python3
• rsvg_path: /usr/bin/rsvg-convert
• poster_storage_period: 5

Update/Installation: new directories that require write permissions

• data/poster/
• var/tmp/