enhydris_instance

Overview

This is an Ansible role for configuring an Enhydris instance on Debian or Ubuntu. It also installs Enhydris (each instance gets its own Enhydris installation). Use enhydris_instance like this:

- role: aptiko.openmeteo.enhydris_instance
  enhydris_version: 2.0.4
  enhydris_major_version: 2
  enhydris_instance_name: openmeteo
  admins:
    - email: admin@example.com
      name: Alice Aniston
  time_zone: UTC
  site_id: 1
  site_domain: example.com
  secret_key: "{{ example_com_secret_key }}"
  account_activation_days: 1
  registration_open: True
  email_use_tls: False
  email_port: 25
  email_host: localhost
  default_from_email: noreply@openmeteo.org
  enhydris_default_publicly_available: True
  enhydris_enable_timeseries_data_viewers: False
  enhydris_users_can_add_content: True
  session_cookie_secure: False
  gunicorn_port: 8001
  extra_settings: |
      MY_SETTING1 = "hello"
      MY_SETTING2 = "world"

Variables

enhydris_instance_name

An identifier for the instance. It is used for directory names, for example.

enhydris_version

Must be specified. A git repository tag or branch.

enhydris_major_version

This can be 2 or 3. You need to specify this because there are a few differences in the configuration, and because it’s not easy to derive this from enhydris_version, as the latter could be something like “master” or “production”.

account_activation_days

registration_open

Settings for django-registration.

additional_static_files

If specified it must be a directory in the Ansible directory; a relative filename from the top-level directory. The directory contents are copied into /etc/opt/enhydris//{{ enhydris_instance_name }}/static/, and collectstatic will pick them up.

admins

A list of hashes having email and name; these will be used for the Django ADMINS setting.

skinrepo

The URL of the repository with the skin, if different from the default.

dbname

dbpasswd

dbuser

Database name and connection credentials. Normally these should be unset; dbname and dbuser both default to enhydris_instance_name, and dbpasswd defaults to secret_key. If specified, and dbname is different from enhydris_instance_name, then it is assumed that this Enhydris instance will not have a database of its own, but instead it will use the database of another instance. For example, https://system.openhi.net/ uses the same database as https://openmeteo.org/, using the multi-site feature of Enhydris.

If dbname is different from enhydris_instance_name, then, additionally, celery and celery beat are not configured, because it is assumed that they run for the other instance.

default_from_email

Django settings DEFAULT_FROM_EMAIL and SERVER_EMAIL. Automatic emails sent from the server to the admins and to the public will appear to be coming from this address.

email_host

email_host_user

email_host_password

email_port

email_use_tls

These are set as the equivalent Django settings; they are used to specify how the server will send automatic emails. email_host_user and email_host_password are optional; if not specified, no smtp authentication is used.

enhydris_authentication_required

enhydris_default_publicly_available

enhydris_enable_timeseries_data_viewers

enhydris_users_can_add_content

The equivalent Enhydris settings; the default for all these is False.

enhydris_sites_for_new_stations

Enhydris setting ENHYDRIS_SITES_FOR_NEW_STATIONS; the default is an empty set.

enhydris_wgs84_name

Enhydris setting ENHYDRIS_WGS84_NAME; the default is “WGS84”.

gunicorn_port

The port on which the gunicorn server will be listening.

secret_key

The Django SECRET_KEY setting. Also used by default as the database password.

session_cookie_secure

The Django SESSION_COOKIE_SECURE setting; default True.

site_domain

The domain where Enhydris is installed. This is used when configuring Apache and for the Django ALLOWED_HOSTS setting.

site_id

time_zone

The equivalent Django settings.

enhydris_timeseries_data_dir

Enhydris setting ENHYDRIS_TIMESERIES_DATA_DIR; the directory in which time series data will be stored. The default is /var/opt/enhydris/{{ enhydris_instance_name }}/timeseries_data. Specifying this is mainly useful if you use the database of another instance (see dbname).

media_root

Django setting MEDIA_ROOT; the directory in which media files will be stored. The default is /var/opt/enhydris/{{ enhydris_instance_name }}/media. Specifying this is mainly useful if you use the database of another instance (see dbname).

use_enhydris_stats

(Deprecated.) If True, the enhydris_stats will be configured for use. Default False.

enhydris_synoptic_station_link_target

The equivalent Enhydris setting.

use_enhydris_openhigis

If True, the enhydris_openhigis app will be configured for use. Default False.

enhydris_aggregator

The contents of the ENHYDRIS_AGGREGATOR setting. If empty, the Enhydris aggregator will not be used.

enhydris_map_base_layers

A list of strings that will go into the ENHYDRIS_MAP_BASE_LAYERS setting. They must contain JavaScript. They may not contain triple string characters.

enhydris_additional_nonenhydris_paths

Apache is set to act as a reverse proxy, sending almost all paths to Enhydris. However, it does not do so for “media/”, “static/”, “synoptic/” and “cgi-bin/”. This variable (a list) can be used to specify additional paths to be excluded, such as “grafana/” or “awstats/”. The items of the list must end but not begin with a slash.

extra_settings

A string that is appended to the Enhydris (Django) settings as is.

enhydris_instance_celery_concurrency

The number of celery workers; default 1.

enhydris_instance_enhydris_repo

The URL of the repository with Enhydris; the default is https://github.com/openmeteo/enhydris.git.