Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Some Avalon features like batch ingest or collection creation send emails. You will need to configure your outbound email for these to be delivered. Avalon can be configured to use a SMTP server or AWS SES. The examples below assume SMTP. To use AWS SES set the mailer to :aws_sdk and ignore the rest of the properties

For a full list of available configuration options see the ActionMailer configuration documentation.

Using Environment Variables

In your .env or docker-compose.yml set the following variables and modify as needed:

SETTINGS__EMAIL__MAILER=smtp
SETTINGS__EMAIL__CONFIG__ADDRESS=mail-relay.university.edu
SETTINGS__EMAIL__CONFIG__PORT=25
SETTINGS__EMAIL__CONFIG__ENABLE_STARTTLS_AUTO=false

Using Settings.yml

In your config/settings/production.local.yml or config/settings.yml file set the following properties and modify as needed:

email:
  mailer: :smtp
  config:
    address: mail-relay.university.edu
    port: 25
    enable_starttls_auto: false

Configuring system email addresses

Avalon uses system email accounts to send email as well as display a support email address to users when certain problems are encountered. A single email address can be used or different email addresses can be configured to tie into existing infrastructure. The different configuration options are listed below including when they are used.

Comments

This email address receives comments submitted by users from the comments form.

Using Environment Variables

SETTINGS__EMAIL__COMMENTS=avalon-comments@example.edu

Using Settings.yml

email:
  comments: 'avalon-comments@example.edu'

Notifications

This email address is used as the from address for emails sent from Avalon including batch ingest emails and collection creation and modification emails sent to administrators. It also receives emails for stalled and unowned batch ingests.

Using Environment Variables

SETTINGS__EMAIL__NOTIFICATION=avalon-notifications@example.edu

Using Settings.yml

email:
  notification: 'avalon-notifications@example.edu'

Support

This email address appears in certain error messages presented to the user when a system administrator is needed to resolve a problem.

Using Environment Variables

SETTINGS__EMAIL__SUPPORT=avalon-support@example.edu

Using Settings.yml

email:
  support: 'avalon-support@example.edu'
  • No labels