diff --git a/docs/configuring-playbook-mxisd.md b/docs/configuring-playbook-mxisd.md index 3b0d5700c..2f5806bb3 100644 --- a/docs/configuring-playbook-mxisd.md +++ b/docs/configuring-playbook-mxisd.md @@ -54,3 +54,11 @@ To learn more about how to do this, refer to the information about `matrix_mxisd ## Troubleshooting If email address validation emails sent by mxisd are not reaching you, you should look into [Adjusting email-sending settings](configuring-playbook-email.md). + +If you'd like additional logging information, temporarily enable verbose logging for mxisd. + +Example configuration (`inventory/host_vars/matrix.DOMAIN/vars.yml`): + +```yaml +matrix_mxisd_verbose_logging: true +``` \ No newline at end of file diff --git a/docs/maintenance-and-troubleshooting.md b/docs/maintenance-and-troubleshooting.md index 18bfdd837..5dd1ee3f5 100644 --- a/docs/maintenance-and-troubleshooting.md +++ b/docs/maintenance-and-troubleshooting.md @@ -37,3 +37,7 @@ Re-run the playbook after making these configuration changes. ## Postgres See the dedicated [PostgreSQL Maintenance](maintenance-postgres.md) documentation page. + +## Mxisd + +See the dedicated [Adjusting mxisd Identity Server configuration](configuring-playbook-mxisd.md) documentation page. \ No newline at end of file diff --git a/roles/matrix-mxisd/defaults/main.yml b/roles/matrix-mxisd/defaults/main.yml index 40eab830e..286839dab 100644 --- a/roles/matrix-mxisd/defaults/main.yml +++ b/roles/matrix-mxisd/defaults/main.yml @@ -68,6 +68,11 @@ matrix_mxisd_threepid_medium_email_custom_matrixid_template: "" # Controls whether the self-check feature should validate SSL certificates. matrix_mxisd_self_check_validate_certificates: true +# Controls mxisd logging verbosity for troubleshooting. +# +# According to: https://github.com/kamax-matrix/mxisd/blob/master/docs/troubleshooting.md#increase-verbosity +matrix_mxisd_verbose_logging: false + # Default mxisd configuration template which covers the generic use case. # You can customize it by controlling the various variables inside it. # diff --git a/roles/matrix-mxisd/templates/systemd/matrix-mxisd.service.j2 b/roles/matrix-mxisd/templates/systemd/matrix-mxisd.service.j2 index 09ebb05d1..d60740f52 100644 --- a/roles/matrix-mxisd/templates/systemd/matrix-mxisd.service.j2 +++ b/roles/matrix-mxisd/templates/systemd/matrix-mxisd.service.j2 @@ -26,6 +26,9 @@ ExecStart=/usr/bin/docker run --rm --name matrix-mxisd \ {% if matrix_mxisd_container_http_host_bind_port %} -p {{ matrix_mxisd_container_http_host_bind_port }}:8090 \ {% endif %} + {% if matrix_mxisd_verbose_logging %} + -e MXISD_LOG_LEVEL=debug \ + {% endif %} -v {{ matrix_mxisd_config_path }}:/etc/mxisd:ro \ -v {{ matrix_mxisd_data_path }}:/var/mxisd:rw \ {% for arg in matrix_mxisd_container_extra_arguments %}