diff --git a/docs/docs/administration/email-notification.mdx b/docs/docs/administration/email-notification.mdx new file mode 100644 index 0000000000..4a2a0b5a83 --- /dev/null +++ b/docs/docs/administration/email-notification.mdx @@ -0,0 +1,23 @@ +# Email Notifications + +Immich supports the option to send notifications via Email for the following events: + +- Creating a new user +- Notifying a user when they get added to a shared album +- Informing other users about the addition of new assets to a shared album + +## SMTP settings + +You can access the settings panel from the web at `Administration -> Settings -> Notification settings` + +Under Email, enter the following details to connect with SMTP servers. + +You can use the following [guide](/docs/guides/smtp-gmail) to use Gmail's SMTP server. + + + +## User's notifications settings + +Users can manage their email notification settings from their account settings page on the web. They can choose to turn email notifications on or off for the following events: + + diff --git a/docs/docs/administration/img/email-settings.png b/docs/docs/administration/img/email-settings.png new file mode 100644 index 0000000000..a0d7135426 Binary files /dev/null and b/docs/docs/administration/img/email-settings.png differ diff --git a/docs/docs/administration/img/immich-email-notefaction.webp b/docs/docs/administration/img/immich-email-notefaction.webp new file mode 100644 index 0000000000..8da19bdc2b Binary files /dev/null and b/docs/docs/administration/img/immich-email-notefaction.webp differ diff --git a/docs/docs/administration/img/send-user-email-notification.webp b/docs/docs/administration/img/send-user-email-notification.webp new file mode 100644 index 0000000000..779461d269 Binary files /dev/null and b/docs/docs/administration/img/send-user-email-notification.webp differ diff --git a/docs/docs/administration/img/user-notifications-settings.png b/docs/docs/administration/img/user-notifications-settings.png new file mode 100644 index 0000000000..d65e4730c7 Binary files /dev/null and b/docs/docs/administration/img/user-notifications-settings.png differ diff --git a/docs/docs/administration/user-management.mdx b/docs/docs/administration/user-management.mdx index 47021fd7c0..c6fb7d5058 100644 --- a/docs/docs/administration/user-management.mdx +++ b/docs/docs/administration/user-management.mdx @@ -13,6 +13,20 @@ Immich supports multiple users, each with their own library. +## Send new user email notification + +:::note +This option is only available if an SMTP server has been configured in the administrator settings. +::: + +Admin can send a welcome email if the Email option is set, you can learn here how to set up the SMTP server in Immich. + + + ## Set Storage Quota For User Admin can specify the storage quota for the user as the instance's admin; once the limit is reached, the user won't be able to upload to the instance anymore. diff --git a/docs/docs/guides/img/email-settings.png b/docs/docs/guides/img/email-settings.png new file mode 100644 index 0000000000..a0d7135426 Binary files /dev/null and b/docs/docs/guides/img/email-settings.png differ diff --git a/docs/docs/guides/img/google-app-password.webp b/docs/docs/guides/img/google-app-password.webp new file mode 100644 index 0000000000..4621b8d9bd Binary files /dev/null and b/docs/docs/guides/img/google-app-password.webp differ diff --git a/docs/docs/guides/smtp-gmail.md b/docs/docs/guides/smtp-gmail.md new file mode 100644 index 0000000000..de015dfe47 --- /dev/null +++ b/docs/docs/guides/smtp-gmail.md @@ -0,0 +1,20 @@ +# SMTP settings using Gmail + +This guide walks you through how to get the information you need to set up your Immich instance to send emails using Gmail's SMTP server. + +## Create an app password + +From your Google account settings + +- Add [2-Step Verification](https://support.google.com/accounts/answer/185839) to your Google account (Required) +- [Create an app password](https://myaccount.google.com/apppasswords). + +At the end of creating your app passwords, a password will be displayed; save it, it will be used for the password field when setting up the SMTP server in Immich. + + + +## Entering the SMTP credential in Immich + +Entering your credential in Immich's email notification settings at `Administration -> Settings -> Notification Settings` + +