From 682cf7db0b98937ab648bc3786dac76d592d78a7 Mon Sep 17 00:00:00 2001 From: Sietse Snel Date: Fri, 8 Sep 2023 21:16:16 +0200 Subject: [PATCH] improve SMTP configuration documentation/comments Add some more information regarding SMTP configuration parameters, in particular regarding how the EUS SMTP parameters changed between Yoda 1.8 and 1.9. --- docs/administration/configuring-yoda.md | 2 +- docs/release-notes/release-1.9.md | 25 +++++++++++++------ .../defaults/main.yml | 2 ++ roles/yoda_rulesets/defaults/main.yml | 2 ++ 4 files changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/administration/configuring-yoda.md b/docs/administration/configuring-yoda.md index 47aaab8bc..3882673fe 100644 --- a/docs/administration/configuring-yoda.md +++ b/docs/administration/configuring-yoda.md @@ -281,7 +281,7 @@ These settings also affect the External User Service (EUS). Variable | Description -----------------------------|--------------------------------------------- -smtp_server | SMTP server to send mail to +smtp_server | SMTP server to send mail to (smtp://server.name:port or smtps://server.name:port, e.g. smtp://localhost:25) smtp_username | SMTP server username smtp_password | SMTP server password smtp_auth | Whether to use SMTP authentication (true/false, default: true) diff --git a/docs/release-notes/release-1.9.md b/docs/release-notes/release-1.9.md index 4e06fc70a..a057e2fd5 100644 --- a/docs/release-notes/release-1.9.md +++ b/docs/release-notes/release-1.9.md @@ -74,43 +74,54 @@ metadata_schemas: active: true ``` -7. Set `postgresql_perform_db_upgrade` to `true` in the configuration to perform the database upgrase from Postgresql 9 to 15. +7. If you use the External User Service (EUS): some EUS parameters have changed from Yoda 1.8 to 1.9. Yoda 1.9 performs server certificate validation of requests from the provider to the EUS server by default. This can be disabled by setting `eus_api_tls_verify` to `false`. For some SMTP parameters, EUS uses joint parameters with the provider in Yoda 1.9: + +| Old parameter (1.8) | New parameter | Notes | +|---------------------|----------------|--------------------------------------| +| eus_smtp_host | smtp_server | New format. e.g. smtp://localhost:25 | +| eus_smtp_port | smtp_server | New format. e.g. smtp://localhost:25 | +| eus_smtp_auth | smtp_auth | | +| eus_smtp_security | smtp_server | New format. e.g. smtp://localhost:25 | + +Please see the [configuration guide](../administration/configuring-yoda.md) for more information. + +8. Set `postgresql_perform_db_upgrade` to `true` in the configuration to perform the database upgrade from Postgresql 9 to 15. Optionally set `postgresql_remove_old_data_after_upgrade` to `true` in the configuration to clean up PostgreSQL 9 data and shim after the upgrade. ```yaml postgresql_perform_db_upgrade: true postgresql_remove_old_data_after_upgrade: false ``` -8. Install all Ansible collections needed to deploy Yoda: +9. Install all Ansible collections needed to deploy Yoda: ```bash ansible-galaxy collection install -r requirements.yml ``` -9. Run the Ansible playbook in check mode. +10. Run the Ansible playbook in check mode. ```bash ansible-playbook -i playbook.yml --check ### EXAMPLE ### ansible-playbook -i /environments/development/allinone playbook.yml --check ``` -10. If the playbook has finished successfully in check mode, run the Ansible playbook normally. +11. If the playbook has finished successfully in check mode, run the Ansible playbook normally. ```bash ansible-playbook -i playbook.yml ### EXAMPLE ### ansible-playbook -i /environments/development/allinone playbook.yml ``` -11. Update all publication metadata to support DOI versioning. +13. Update all publication metadata to support DOI versioning. ```bash irule -r irods_rule_engine_plugin-python-instance -F /etc/irods/yoda-ruleset/tools/transform-existing-publications.r ``` -12. Update all metadata JSON in the vault to latest metadata JSON version (`default-2` to `default-3`). +14. Update all metadata JSON in the vault to latest metadata JSON version (`default-2` to `default-3`). ```bash irule -r irods_rule_engine_plugin-irods_rule_language-instance -F /etc/irods/yoda-ruleset/tools/check-metadata-for-schema-updates.r ``` -13. Update publication endpoints if there are published packages (DataCite, landingpages and OAI-PMH): +15. Update publication endpoints if there are published packages (DataCite, landingpages and OAI-PMH): ```bash irule -r irods_rule_engine_plugin-irods_rule_language-instance -F /etc/irods/yoda-ruleset/tools/update-publications.r ``` diff --git a/roles/yoda_external_user_service/defaults/main.yml b/roles/yoda_external_user_service/defaults/main.yml index bf000390b..898b76511 100644 --- a/roles/yoda_external_user_service/defaults/main.yml +++ b/roles/yoda_external_user_service/defaults/main.yml @@ -25,6 +25,8 @@ eus_db_password: PLACEHOLDER eus_db_users_id_seq: users_id_seq smtp_server: PLACEHOLDER # SMTP server to send mail to + # (smtp://server.name:port or smtps://server.name:port, + # e.g. smtp://localhost:25) smtp_username: PLACEHOLDER # SMTP server username smtp_password: PLACEHOLDER # SMTP server password smtp_auth: true # Whether to use SMTP authentication diff --git a/roles/yoda_rulesets/defaults/main.yml b/roles/yoda_rulesets/defaults/main.yml index fbcde0fd8..b67e2283a 100644 --- a/roles/yoda_rulesets/defaults/main.yml +++ b/roles/yoda_rulesets/defaults/main.yml @@ -124,6 +124,8 @@ notifications_sender_name: "Yoda system" # Notifiations sender name notifications_reply_to: noreply@yoda.test # Notifiations Reply-To email address smtp_server: PLACEHOLDER # SMTP server to send mail to + # (smtp://server.name:port or smtps://server.name:port, + # e.g. smtp://localhost:25) smtp_username: PLACEHOLDER # SMTP server username smtp_password: PLACEHOLDER # SMTP server password smtp_auth: true # Whether to use SMTP authentication