diff --git a/openmetadata-docs/content/partials/v1.6/deployment/smtp-email.md b/openmetadata-docs/content/partials/v1.6/deployment/smtp-email.md new file mode 100644 index 00000000000..405541a1d40 --- /dev/null +++ b/openmetadata-docs/content/partials/v1.6/deployment/smtp-email.md @@ -0,0 +1,23 @@ +### Setting up SMTP Server + +Basic Authentication is successfully set. For a better login experience, we can also set up the SMTP server to allow the +users to Reset Password, Account Status Updates, etc. as well. + +```yaml +email: + emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) + supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) + enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False + senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL:-""} -> Sender's email + serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) + serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) + username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) + password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) + transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} +``` + +Following are valid value for transportation strategy: + +- `SMTP`: If SMTP port is 25 use this +- `SMTPS`: If SMTP port is 465 use this +- `SMTP_TLS`: If SMTP port is 587 use this diff --git a/openmetadata-docs/content/partials/v1.6/how-to-guides/email.md b/openmetadata-docs/content/partials/v1.6/how-to-guides/email.md new file mode 100644 index 00000000000..4d82fd1963e --- /dev/null +++ b/openmetadata-docs/content/partials/v1.6/how-to-guides/email.md @@ -0,0 +1,23 @@ +### Email +To enable email alerts you will need to ensure that you have an SMTP server available. With the information for your SMTP server you can configure OpenMetadata to send email alerts either by updating the details from the UI or by updating the below section of the `operations.yaml` file. + +To update the details from the UI, navigate to Settings > Preferences > Email + +{% image +src="/images/v1.6/how-to-guides/admin-guide/email.webp" +alt="Email Configuration" +caption="Email Configuration" +/%} + +``` +email: + emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) + supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) + enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False + senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL} + serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) + serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) + username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) + password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) + transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} +``` diff --git a/openmetadata-docs/content/partials/v1.7/deployment/smtp-email.md b/openmetadata-docs/content/partials/v1.7/deployment/smtp-email.md new file mode 100644 index 00000000000..405541a1d40 --- /dev/null +++ b/openmetadata-docs/content/partials/v1.7/deployment/smtp-email.md @@ -0,0 +1,23 @@ +### Setting up SMTP Server + +Basic Authentication is successfully set. For a better login experience, we can also set up the SMTP server to allow the +users to Reset Password, Account Status Updates, etc. as well. + +```yaml +email: + emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) + supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) + enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False + senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL:-""} -> Sender's email + serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) + serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) + username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) + password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) + transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} +``` + +Following are valid value for transportation strategy: + +- `SMTP`: If SMTP port is 25 use this +- `SMTPS`: If SMTP port is 465 use this +- `SMTP_TLS`: If SMTP port is 587 use this diff --git a/openmetadata-docs/content/partials/v1.7/how-to-guides/email.md b/openmetadata-docs/content/partials/v1.7/how-to-guides/email.md new file mode 100644 index 00000000000..0162a881375 --- /dev/null +++ b/openmetadata-docs/content/partials/v1.7/how-to-guides/email.md @@ -0,0 +1,23 @@ +### Email +To enable email alerts you will need to ensure that you have an SMTP server available. With the information for your SMTP server you can configure OpenMetadata to send email alerts either by updating the details from the UI or by updating the below section of the `operations.yaml` file. + +To update the details from the UI, navigate to Settings > Preferences > Email + +{% image +src="/images/v1.7/how-to-guides/admin-guide/email.webp" +alt="Email Configuration" +caption="Email Configuration" +/%} + +``` +email: + emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) + supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) + enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False + senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL} + serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) + serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) + username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) + password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) + transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} +``` diff --git a/openmetadata-docs/content/partials/v1.8/deployment/smtp-email.md b/openmetadata-docs/content/partials/v1.8/deployment/smtp-email.md new file mode 100644 index 00000000000..405541a1d40 --- /dev/null +++ b/openmetadata-docs/content/partials/v1.8/deployment/smtp-email.md @@ -0,0 +1,23 @@ +### Setting up SMTP Server + +Basic Authentication is successfully set. For a better login experience, we can also set up the SMTP server to allow the +users to Reset Password, Account Status Updates, etc. as well. + +```yaml +email: + emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) + supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) + enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False + senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL:-""} -> Sender's email + serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) + serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) + username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) + password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) + transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} +``` + +Following are valid value for transportation strategy: + +- `SMTP`: If SMTP port is 25 use this +- `SMTPS`: If SMTP port is 465 use this +- `SMTP_TLS`: If SMTP port is 587 use this diff --git a/openmetadata-docs/content/partials/v1.8/how-to-guides/email.md b/openmetadata-docs/content/partials/v1.8/how-to-guides/email.md new file mode 100644 index 00000000000..3f36ba34a16 --- /dev/null +++ b/openmetadata-docs/content/partials/v1.8/how-to-guides/email.md @@ -0,0 +1,23 @@ +### Email +To enable email alerts you will need to ensure that you have an SMTP server available. With the information for your SMTP server you can configure OpenMetadata to send email alerts either by updating the details from the UI or by updating the below section of the `operations.yaml` file. + +To update the details from the UI, navigate to Settings > Preferences > Email + +{% image +src="/images/v1.8/how-to-guides/admin-guide/email.webp" +alt="Email Configuration" +caption="Email Configuration" +/%} + +``` +email: + emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) + supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) + enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False + senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL} + serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) + serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) + username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) + password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) + transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} +``` diff --git a/openmetadata-docs/content/v1.6.x/deployment/security/basic-auth/index.md b/openmetadata-docs/content/v1.6.x/deployment/security/basic-auth/index.md index e756e853ab3..09dfe2b0cdd 100644 --- a/openmetadata-docs/content/v1.6.x/deployment/security/basic-auth/index.md +++ b/openmetadata-docs/content/v1.6.x/deployment/security/basic-auth/index.md @@ -92,30 +92,6 @@ After logging into the OpenMetadata UI, admin users can change their default pas For ingesting metadata when Basic Auth is enabled, it is mandatory to configure the `ingestion-bot` account with the JWT configuration. To know how to enable it, you can follow the documentation of [Enable JWT Tokens](/deployment/security/enable-jwt-tokens). - -### Setting up SMTP Server - -Basic Authentication is successfully set. For a better login experience, we can also set up the SMTP server to allow the -users to Reset Password, Account Status Updates, etc. as well. - -```yaml -email: - emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) - supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) - enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False - openMetadataUrl: ${OPENMETADATA_SERVER_URL:-""} -> {http/https}://{your_domain} - senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL:-""} -> Sender's email - serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) - serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) - username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) - password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) - transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} -``` - -Following are valid value for transportation strategy: - -- `SMTP`: If SMTP port is 25 use this -- `SMTPS`: If SMTP port is 465 use this -- `SMTP_TLS`: If SMTP port is 587 use this +{% partial file="/v1.6/deployments/smtp-email.md" /%} {% partial file="/v1.6/deployment/configure-ingestion.md" /%} diff --git a/openmetadata-docs/content/v1.6.x/how-to-guides/admin-guide/alerts.md b/openmetadata-docs/content/v1.6.x/how-to-guides/admin-guide/alerts.md index 2a47c0585ea..7d2b0f01a21 100644 --- a/openmetadata-docs/content/v1.6.x/how-to-guides/admin-guide/alerts.md +++ b/openmetadata-docs/content/v1.6.x/how-to-guides/admin-guide/alerts.md @@ -134,30 +134,7 @@ caption="Define the Filter" ## Additional Details for the Configuration of Destinations -### Email -To enable email alerts you will need to ensure that you have an SMTP server available. With the information for your SMTP server you can configure OpenMetadata to send email alerts either by updating the details from the UI or by updating the below section of the `openmetadata.yaml` file. - -To update the details from the UI, navigate to Settings > Preferences > Email - -{% image -src="/images/v1.6/how-to-guides/admin-guide/email.webp" -alt="Email Configuration" -caption="Email Configuration" -/%} - -``` -email: - emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) - supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) - enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False - openMetadataUrl: ${OPENMETADATA_SERVER_URL:-""} -> {http/https}://{your_domain} - senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL} - serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) - serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) - username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) - password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) - transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} -``` +{% partial file="/v1.6/how-to-guides/email.md" /%} ### Slack For Slack configuration you will need to get the endpoint URL of the channel where you wish to send the alerts. Additionally, you can configure the following parameters: diff --git a/openmetadata-docs/content/v1.7.x/deployment/security/basic-auth/index.md b/openmetadata-docs/content/v1.7.x/deployment/security/basic-auth/index.md index 14fa11930c3..23c8f80d8db 100644 --- a/openmetadata-docs/content/v1.7.x/deployment/security/basic-auth/index.md +++ b/openmetadata-docs/content/v1.7.x/deployment/security/basic-auth/index.md @@ -92,30 +92,6 @@ After logging into the OpenMetadata UI, admin users can change their default pas For ingesting metadata when Basic Auth is enabled, it is mandatory to configure the `ingestion-bot` account with the JWT configuration. To know how to enable it, you can follow the documentation of [Enable JWT Tokens](/deployment/security/enable-jwt-tokens). - -### Setting up SMTP Server - -Basic Authentication is successfully set. For a better login experience, we can also set up the SMTP server to allow the -users to Reset Password, Account Status Updates, etc. as well. - -```yaml -email: - emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) - supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) - enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False - openMetadataUrl: ${OPENMETADATA_SERVER_URL:-""} -> {http/https}://{your_domain} - senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL:-""} -> Sender's email - serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) - serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) - username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) - password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) - transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} -``` - -Following are valid value for transportation strategy: - -- `SMTP`: If SMTP port is 25 use this -- `SMTPS`: If SMTP port is 465 use this -- `SMTP_TLS`: If SMTP port is 587 use this +{% partial file="/v1.7/deployments/smtp-email.md" /%} {% partial file="/v1.7/deployment/configure-ingestion.md" /%} diff --git a/openmetadata-docs/content/v1.7.x/how-to-guides/admin-guide/alerts.md b/openmetadata-docs/content/v1.7.x/how-to-guides/admin-guide/alerts.md index 3e03275748b..12efdc996ed 100644 --- a/openmetadata-docs/content/v1.7.x/how-to-guides/admin-guide/alerts.md +++ b/openmetadata-docs/content/v1.7.x/how-to-guides/admin-guide/alerts.md @@ -144,30 +144,7 @@ caption="Define the Filter" ## Additional Details for the Configuration of Destinations -### Email -To enable email alerts you will need to ensure that you have an SMTP server available. With the information for your SMTP server you can configure OpenMetadata to send email alerts either by updating the details from the UI or by updating the below section of the `openmetadata.yaml` file. - -To update the details from the UI, navigate to Settings > Preferences > Email - -{% image -src="/images/v1.7/how-to-guides/admin-guide/email.webp" -alt="Email Configuration" -caption="Email Configuration" -/%} - -``` -email: - emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) - supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) - enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False - openMetadataUrl: ${OPENMETADATA_SERVER_URL:-""} -> {http/https}://{your_domain} - senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL} - serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) - serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) - username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) - password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) - transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} -``` +{% partial file="/v1.7/how-to-guides/email.md" /%} ### Slack For Slack configuration you will need to get the endpoint URL of the channel where you wish to send the alerts. Additionally, you can configure the following parameters: diff --git a/openmetadata-docs/content/v1.8.x-SNAPSHOT/deployment/security/basic-auth/index.md b/openmetadata-docs/content/v1.8.x-SNAPSHOT/deployment/security/basic-auth/index.md index cec7d1170ee..2e46cd5614b 100644 --- a/openmetadata-docs/content/v1.8.x-SNAPSHOT/deployment/security/basic-auth/index.md +++ b/openmetadata-docs/content/v1.8.x-SNAPSHOT/deployment/security/basic-auth/index.md @@ -92,30 +92,6 @@ After logging into the OpenMetadata UI, admin users can change their default pas For ingesting metadata when Basic Auth is enabled, it is mandatory to configure the `ingestion-bot` account with the JWT configuration. To know how to enable it, you can follow the documentation of [Enable JWT Tokens](/deployment/security/enable-jwt-tokens). - -### Setting up SMTP Server - -Basic Authentication is successfully set. For a better login experience, we can also set up the SMTP server to allow the -users to Reset Password, Account Status Updates, etc. as well. - -```yaml -email: - emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) - supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) - enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False - openMetadataUrl: ${OPENMETADATA_SERVER_URL:-""} -> {http/https}://{your_domain} - senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL:-""} -> Sender's email - serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) - serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) - username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) - password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) - transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} -``` - -Following are valid value for transportation strategy: - -- `SMTP`: If SMTP port is 25 use this -- `SMTPS`: If SMTP port is 465 use this -- `SMTP_TLS`: If SMTP port is 587 use this +{% partial file="/v1.8/deployments/smtp-email.md" /%} {% partial file="/v1.8/deployment/configure-ingestion.md" /%} diff --git a/openmetadata-docs/content/v1.8.x-SNAPSHOT/how-to-guides/admin-guide/alerts.md b/openmetadata-docs/content/v1.8.x-SNAPSHOT/how-to-guides/admin-guide/alerts.md index 83f04d68f2b..542996459d1 100644 --- a/openmetadata-docs/content/v1.8.x-SNAPSHOT/how-to-guides/admin-guide/alerts.md +++ b/openmetadata-docs/content/v1.8.x-SNAPSHOT/how-to-guides/admin-guide/alerts.md @@ -144,30 +144,7 @@ caption="Define the Filter" ## Additional Details for the Configuration of Destinations -### Email -To enable email alerts you will need to ensure that you have an SMTP server available. With the information for your SMTP server you can configure OpenMetadata to send email alerts either by updating the details from the UI or by updating the below section of the `openmetadata.yaml` file. - -To update the details from the UI, navigate to Settings > Preferences > Email - -{% image -src="/images/v1.8/how-to-guides/admin-guide/email.webp" -alt="Email Configuration" -caption="Email Configuration" -/%} - -``` -email: - emailingEntity: ${OM_EMAIL_ENTITY:-"OpenMetadata"} -> Company Name (Optional) - supportUrl: ${OM_SUPPORT_URL:-"https://slack.open-metadata.org"} -> SupportUrl (Optional) - enableSmtpServer : ${AUTHORIZER_ENABLE_SMTP:-false} -> True/False - openMetadataUrl: ${OPENMETADATA_SERVER_URL:-""} -> {http/https}://{your_domain} - senderMail: ${OPENMETADATA_SMTP_SENDER_MAIL} - serverEndpoint: ${SMTP_SERVER_ENDPOINT:-""} -> (Ex :- smtp.gmail.com) - serverPort: ${SMTP_SERVER_PORT:-""} -> (SSL/TLS port) - username: ${SMTP_SERVER_USERNAME:-""} -> (SMTP Server Username) - password: ${SMTP_SERVER_PWD:-""} -> (SMTP Server Password) - transportationStrategy: ${SMTP_SERVER_STRATEGY:-"SMTP_TLS"} -``` +{% partial file="/v1.8/how-to-guides/email.md" /%} ### Slack For Slack configuration you will need to get the endpoint URL of the channel where you wish to send the alerts. Additionally, you can configure the following parameters: