mirror of
https://github.com/sct/overseerr.git
synced 2025-12-27 16:46:29 +01:00
ce02f61c0d
* docs: setup docusaurus for documentation * docs: setup tailwind content for docusaurus * chore: ensure tailwindcss is installed so pages deploy works * docs: add cname to point to docs * ci: override format checking for pnpm-lock in gen-docs folder * docs(gen-docs): readme for docusaurus * chore(gen-docs): remove unnecessary image files * docs: remove installation instructions (moved to docs) * ci: rename docusaurus workflows to a more explicit name * style(gen-docs): custom color for links * docs: add more doc pages * style: gradient menu link bg, proper jellyseerr font & footer bg color * docs: fix proper link to relative pages * style: tab-items also now uses the proper jellyseerr colors * style: use prismTheme shadesOfPurple for codeblock/syntax highlighting * docs: fix broken links * docs: fix broken links * docs: fix broken anchors * chore(gen-docs): local search bar * style(gen-docs): tab colors * docs: reverse-proxy documentation * style(gen-docs): jellyseerr-like cards * docs: rename baremetal to build from source * docs: nixpkg version check component * docs: conditionally render override package derivation block and admonitions * docs: users section of the documentation
51 lines
2.1 KiB
Markdown
51 lines
2.1 KiB
Markdown
---
|
|
title: Email
|
|
description: Configure email notifications for your users.
|
|
sidebar_position: 1
|
|
---
|
|
|
|
# Email
|
|
|
|
## Configuration
|
|
|
|
:::info
|
|
If the [Application URL](/using-jellyseerr/settings/general#application-title) setting is configured in **Settings → General**, Jellyseerr will explicitly set the origin server hostname when connecting to the SMTP host.
|
|
:::
|
|
|
|
### Sender Name (optional)
|
|
|
|
Configure a friendly name for the email sender (e.g., "Jellyseerr").
|
|
|
|
### Sender Address
|
|
|
|
Set this to the email address you would like to appear in the "from" field of the email message.
|
|
|
|
Depending on your email provider, this may need to be an address you own. For example, Gmail requires this to be your actual email address.
|
|
|
|
### SMTP Host
|
|
|
|
Set this to the hostname or IP address of your SMTP server.
|
|
|
|
### SMTP Port
|
|
|
|
Set this to a supported port number for your SMTP host. `465` and `587` are commonly used.
|
|
|
|
### Encryption Method
|
|
|
|
In most cases, [Use Implicit TLS](https://tools.ietf.org/html/rfc8314) should be selected for port 465, and [Use STARTTLS](https://en.wikipedia.org/wiki/Opportunistic_TLS) if available for port 587. Please refer to your email provider's documentations for details on how to configure this setting.
|
|
|
|
The default value for this setting is **Use STARTTLS if available**.
|
|
|
|
### SMTP Username & Password
|
|
|
|
:::info
|
|
If your account has two-factor authentication enabled, you may need to create an application password instead of using your account password.
|
|
:::
|
|
Configure these values as appropriate to authenticate with your SMTP host.
|
|
|
|
### PGP Private Key & Password (optional)
|
|
|
|
Configure these values to enable encrypting and signing of email messages using [OpenPGP](https://www.openpgp.org/). Note that individual users must also have their **PGP public keys** configured in their user settings in order for PGP encryption to be used in messages addressed to them.
|
|
|
|
When configuring the PGP keys, be sure to keep the entire contents of the key intact. For example, private keys always begin with `-----BEGIN PGP PRIVATE KEY BLOCK-----` and end with `-----END PGP PRIVATE KEY BLOCK-----`.
|