Ansibleロール: Matomo

このロールは、DebianおよびUbuntuサーバー上でMatomoを基本的にセットアップします。

初期設定はWebインターフェースを通じて行う必要があります。

知られている問題

特になし。

要件

特別な要件はありませんが、このロールにはrootアクセスが必要です。そのため、グローバルに become: yes を設定したプレイブックで実行するか、以下のようにプレイブック内でロールを呼び出してください。

    - hosts: foobar
      roles:
        - role: thorian93.matomo
          become: yes

ロール変数

利用可能な変数は以下に示されるとともに、デフォルト値が設定されています（defaults/main.ymlを参照）。

    matomo_version: ''

この値を明示的なバージョン（例: 4.2.1）に設定します。デフォルトでは最新バージョンがインストールされます。

    matomo_external_url: "{{ inventory_hostname }}"

Matomoが使用する外部URL。

    matomo_use_proxy: false

Matomoがインターネットにアクセスするためにプロキシを必要とするかどうかを定義します。

    matomo_create_self_signed_cert: true
    matomo_self_signed_cert_subj: "/C=DE/ST=FOO/L=BAR/O=Org/CN={{ matomo_external_url }}"
    matomo_self_signed_certificate_key: "/etc/{{ apache2_http_name }}/ssl/matomo.key"
    matomo_self_signed_certificate: "/etc/{{ apache2_http_name }}/ssl/matomo.crt"

自己署名証明書の設定を行います。

    matomo_custom_cert: false
    matomo_custom_cert_file: /etc/{{ apache2_http_name }}/ssl/custom.crt
    matomo_custom_cert_key: /etc/{{ apache2_http_name }}/ssl/custom.key

独自の証明書を使用したい場合は、ここで定義できます。

    matomo_certificate_key: "{{ certbot_cert_path }}/privkey.pem"
    matomo_certificate: "{{ certbot_cert_path }}/cert.pem"
    matomo_certificate_chain: "{{ certbot_cert_path }}/fullchain.pem"

matomo_create_self_signed_cert と matomo_custom_cert が false に設定されている場合、thorian93.certbot が証明書を取得するために使用されます。

    matomo_db_system: "mysql"
    matomo_db_name: "matomo"
    matomo_db_user: "matomo"
    matomo_db_pw: "matomo"

データベースの設定を行います。現在利用可能なのはMySQL/MariaDBのみです。デフォルトのユーザー名とパスワードは必ず変更してください。

    matomo_redirect_http_to_https: true

MatomoがデフォルトですべてのリクエストをHTTPSにリダイレクトするかどうかを設定します。

    matomo_backup: false
    matomo_backup_dir: "/tmp/matomo"

Matomoのバックアップを設定します。

    matomo_log_dir: "/tmp/matomo/logs"

カスタムログ用のディレクトリ、例えばバックアップ用です。

    matomo_web_dir: "/var/www/matomo"

MatomoのWebルートを定義します。

    matomo_scripts_dir: "{{ matomo_web_dir }}/scripts"

カスタムスクリプト用のディレクトリ、例えばバックアップ用です。

    matomo_php_options:
      - line: "php_value open_basedir {{ matomo_web_dir }}:/usr/share/php:/usr/share/pear"
        regexp: "^php_value open_basedir"

Matomo用のPHPオプションを定義します。ここで設定されているデフォルト値は、Matomoが正しく動作するために必要です。

    matomo_mysql_options:
      - line: "max_allowed_packet = 64M"
        regexp: "^max_allowed_packet.*"

Matomo用のMySQLオプションを定義します。ここで設定されているデフォルト値は、Matomoが正しく動作するために必要です。

依存関係

• thorian93.ansible-role-apache2
• thorian93.ansible-role-php
• thorian93.ansible-role-certbot - カスタムまたは自己署名証明書を使用しない場合
• geerlingguy.mysql

OSの互換性

このロールは、サポートされていないまたは未テストのオペレーティングシステムで使用されないように、適切なディストリビューション名とメジャーバージョン番号が <role-name>_stable_os という名前の専用変数に存在するかを確認します。この変数はロールのデフォルト変数ファイル defaults/main.yml に見つけることができます。

    role_stable_os:
      - Debian 10
      - Ubuntu 18
      - CentOS 7
      - Fedora 30

ディストリビューションとメジャーバージョンの組み合わせが対象システムと一致しない場合、ロールは失敗します。このロールを機能させるために、ディストリビューション名とメジャーバージョン名をその変数に追加してください。ただし、新しい組み合わせを最初にテストしてください！

このアイデアを提供してくれた HarryHarcourt に感謝します！

サンプルプレイブック

    ---
    - name: "ロールを実行"
      hosts: all
      become: yes
      roles:
        - ansible-role-matomo

貢献

バグや問題を見つけた場合、または改善の余地があると思われる場合は、自由に問題をオープンしてください。また、何かを尋ねたり話し合ったりしたい場合は、いつでも気軽に連絡してください。

免責事項

このロールは現状のままで提供されており、意図通りに動作することを保証するものではなく、このロールによって生じた損害や誤設定についても責任を負いません。使用する前にロールを十分に調査してください。

ライセンス

MIT

著者情報

このロールは2020年に Thorian93 によって作成されました。