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

Latest commit

 

History

History
162 lines (153 loc) · 6.5 KB

configuration.rst

File metadata and controls

162 lines (153 loc) · 6.5 KB

Configuration

RUNALYZE needs at least database parameters to work. Copying a default app/config/default_config.yml to data/config.yml is part of the :doc:`Installation process <installation/4.x>`.

All parameters are optional. If they are not in your custom data/config.yml default values from app/config/default_config.yml will be used. Still, we recommend to include all parameters in your custom configuration.

Note

You need to clear your cache (var/cache/prod/ in general) for the changes to take effect.

Warning

Strings containing special characters must be enclosed in quotes, see these docs.

Examplary configuration

parameters:
  locale: en
  database_host: 127.0.0.1
  database_prefix: runalyze_
  database_port: 3306
  database_name: runalyze
  database_user: root
  database_password: "My$3cr3tP4$$w0rd!"
  secret: "please_change_this_secret"
  update_disabled: no
  user_can_register: true
  user_disable_account_activation: false
  maintenance: false
  garmin_api_key:
  openweathermap_api_key:
  darksky_api_key:
  nokia_here_appid:
  nokia_here_token:
  thunderforest_api_key:
  mapbox_api_key:
  geonames_username:
  perl_path: /usr/bin/perl
  python3_path: /usr/bin/python3
  rsvg_path: /usr/bin/rsvg-convert
  inkscape_path: /usr/bin/inkscape
  ttbin_path: ../call/perl/ttbincnv
  sqlite_mod_spatialite: libspatialite.so.5
  mail_sender: [email protected]
  mail_name: Example sender name
  smtp_host: smtp.gmail.com
  smtp_port: 587
  smtp_security: tls
  smtp_username: [email protected]
  smtp_password: <password>
  backup_storage_period: 5
  poster_storage_period: 5
  router.request_context.host: runalyze.com
  router.request_context.scheme: https
  router.request_context.base_url:

Configuration variables

locale
Default language, see data_config_lang.php for available languages
database_host
Host name of your database, localhost or 127.0.0.1 for local installations, otherwise specific to your hoster
database_prefix
Prefix for all RUNALYZE tables in your database, by default runalyze_. Changing this value is only needed if you want to keep multiple installations in one database.
database_port
Port number for database connection, defaults to 3306
database_name
Name of your database, you need to creat it if it does not already exist
database_user
Username for database connection
database_password
Password for database connection
secret
Installation specific secret that is used for hashing. Just use your own string.
update_disabled
Setting this parameter to yes will disable all pages for installing and updating RUNALYZE to protect public installations. Updates via console are still possible. This parameter defaults to no such that the installation is possible.
user_can_register
Flag if users can register. Set to false to disable registration form.
user_disable_account_activation
Flag if accounts need to be activated. Set to false to automatically activate accounts after registration.
maintenance
Set to True to enable maintenance mode. Only updater and installer will work during maintenance mode.
garmin_api_key
Api key for GarminCommunicator, required to directly import activities from a connected Garmin device
openweathermap_api_key
Api key for openweathermap.org, required to load weather data. Free key does only have access to current weather
darksky_api_key
Api key for darksky.net, required to load weather data. Free key includes current and historical weather information. (1000 requests per day are free)
nokia_here_appid
App id for HERE access, see developer.here.com, required to use HERE maps
nokia_here_token
Token for HERE access
thunderforest_api_key
Api key for thunderforest layers (for activity maps), see thunderforest.com
mapbox_api_key
Api key for mapbox outdoor layer (for activity maps), see mapbox.com
geonames_username
Username for geonames.org, used for elevation correction if no local srtm files are available
perl_path
Path to your perl binary, usually /usr/bin/perl or something like C:\[...]\xampp\perl\bin\perl on Windows.
python3_path
Path to your python binary (v3+), usually /usr/bin/python3.
rsvg_path
Path to your rsvg-convert binary, usually /usr/bin/rsvg-convert.
inkscape_path
Path to your inkscape binary, usually /usr/bin/inkscape.
ttbin_path
Path to ttbin converter that is required for reading binary ttbin files. A compiled version is located under call/perl/ttbincnv but you may need to compile it for your os manually, see ryanbinns/ttwach
sqlite_mod_spatialite
Name of SQLite spatialite extension, usually libspatialite.so.5. This extension is required if you want to use data/timezone.sqlite for time zone lookups of activities based on their coordinates.
mail_sender
Mail adress that will be used as sender for outgoing mails, [email protected] will be used if this value is empty.
mail_name
Name that will be used as sender for outgoing mails
smtp_host
Host for smtp server
smtp_port
Port for smtp server
smtp_security
Security setting, set to ssl or tls if you wish to use the encryption
smtp_username
Password for smtp server
smtp_password
Password for smtp server
backup_storage_period
Default storage period for backups (in days)
poster_storage_period
Default storage period for poster (in days)
router.request_context.host
Needed for correct urls in mails. Set your domain name here.
router.request_context.scheme
Needed for correct urls in mails. Set to https or http
router.request_context.base_url
Needed for correct urls in mails. Set it to e.g. /runalyze if you are using subdirectories (you should not do that)