Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add Email Notifications info #9930

Merged
merged 11 commits into from
Jun 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/docs/administration/email-notification.mdx
Original file line number Diff line number Diff line change
@@ -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.

<img src={require('./img/email-settings.png').default} width="80%" title="SMTP settings" />

## 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:

<img src={require('./img/user-notifications-settings.png').default} width="80%" title="User notification settings" />
Binary file added docs/docs/administration/img/email-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/docs/administration/user-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ Immich supports multiple users, each with their own library.

<UserCreate />

## 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.

<img
src={require('./img/send-user-email-notification.webp').default}
width="40%"
title="Send user email notification"
/>

## 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.
Expand Down
Binary file added docs/docs/guides/img/email-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docs/guides/img/google-app-password.webp
Binary file not shown.
20 changes: 20 additions & 0 deletions docs/docs/guides/smtp-gmail.md
Original file line number Diff line number Diff line change
@@ -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.

<img src={require('./img/google-app-password.webp').default} title="Authorised redirect URIs" />

## Entering the SMTP credential in Immich

Entering your credential in Immich's email notification settings at `Administration -> Settings -> Notification Settings`

<img src={require('./img/email-settings.png').default} width="80%" title="SMTP settings" />
Loading