Skip to content

Commit d69fd23

Browse files
github-automation-metabaseMetabase Docs bot
andauthored
[auto] adding content to docs-cloud-custom-smtp-server->master (#354)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent 86c7a91 commit d69fd23

File tree

277 files changed

+8106
-351
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

277 files changed

+8106
-351
lines changed

_docs/master/configuring-metabase/config-template.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,6 @@ config:
266266
surveys-enabled: true
267267
synchronous-batch-updates: false
268268
unaggregated-query-row-limit: null
269-
update-channel: latest
270269
uploads-settings: null
271270
use-tenants: false
272271
user-visibility: all

_docs/master/configuring-metabase/email.md

Lines changed: 63 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,73 @@ category: 'Configuring Metabase'
77
title: 'Set up email'
88
source_url: 'https://github.com/metabase/metabase/blob/master/docs/configuring-metabase/email.md'
99
layout: new-docs
10+
summary: 'Learn how to set up email in Metabase to enable dashboard subscriptions and alerts.'
1011
redirect_from:
1112
- /docs/master/administration-guide/02-setting-up-email
1213
---
1314

1415
# Set up email
1516

16-
Once you connect your database to Metabase, you'll want to configure an email account to send system notifications to your organization's users. Metabase uses email to reset passwords, onboard new users, and notify you when something happens.
17+
Once you connect your database to Metabase, you'll want to configure an email account to send system notifications to your organization's users. Metabase uses email to reset passwords, onboard new users, and notify you when something happens (see [dashboard subscriptions](../dashboards/subscriptions) and [alerts](../questions/alerts)).
1718

18-
To edit email settings:
19+
## Email on Metabase Cloud
1920

20-
1. Click on the **gear** icon in the upper right.
21-
2. Select **Admin Settings**.
22-
3. From the default **Settings** tab, click on **Notification channels** in the left sidebar.
23-
4. Select **Email**.
21+
_Admin settings > Settings > Email_
2422

25-
## Metabase Cloud
23+
On Metabase Cloud, you can use the default SMTP server, or set up a custom server.
2624

27-
Metabase Cloud manages an email server for you, so you don't need to set up email (and you won't see SMTP settings in your Admin console).
25+
### Default SMTP server on Metabase Cloud
26+
27+
By default, Metabase Cloud will manage an email server for you, so you don't need to set up email.
2828

2929
If you like, you can still set up:
3030

31-
- A name for your Cloud email account (from name)
32-
- An email address to receive email replies (reply-to address)
31+
- A display name for your Cloud email account (the "from" name). The email will still be sent from a Metabase address, however.
32+
- An email address to receive email replies (reply-to address).
33+
34+
When Metabase manages the SMTP server, you can't change the from address. If you want Metabase to send emails from a different domain, you'll need to bring your own SMTP server. See below.
35+
36+
### Custom SMTP Server on Metabase Cloud
37+
38+
{% include plans-blockquote.html feature="Custom SMTP server on Metabase Cloud" %}
39+
40+
_Admin settings > Settings > Email > Set up a custom SMTP server_
41+
42+
By default, Metabase Cloud manages an SMTP server for you. But if you want to use your own SMTP server, you can bring your own.
43+
44+
You may want to use your own SMTP server if you want to:
45+
46+
- Customize the From domain (for example, if you're [white-labeling Metabase](./appearance)).
47+
- Avoid having emails pass through 3rd-party services.
48+
- Own IP reputation, logs, monitoring.
49+
- Own auditing.
50+
51+
When setting up a custom SMTP server on Metabase Cloud, you'll configure these fields:
52+
53+
- **SMTP HOST**: The address of the SMTP server that handles your emails (e.g., smtp.yourservice.com).
54+
- **SMTP PORT**: The port your SMTP server uses for outgoing emails. Only encrypted email ports are supported:
55+
- 465 (SSL)
56+
- 587 (TLS)
57+
- 2525 (STARTTLS)
58+
- **SMTP SECURITY**: Choose the security protocol for your connection:
59+
- SSL
60+
- TLS
61+
- STARTTLS
62+
- **SMTP USERNAME**: Your SMTP account username.
63+
- **SMTP PASSWORD**: Your SMTP account password.
64+
65+
You'll also need to specify:
66+
67+
- **From address**: The email address you want to use for the sender of emails.
68+
- **Reply-to address**: The email address you want replies to go to, if different from the From address.
69+
70+
You can edit these settings at any time. You can also toggle between this custom SMTP server and the server managed by Metabase Cloud.
3371

3472
## Configuring your email account
3573

36-
For Metabase to send messages to your organization's users, you'll need to set up an email account to send emails via **SMTP** (simple mail transfer protocol), which is an email standard that secures emails with SSL security protection.
74+
_Admin settings > Settings > Email_
75+
76+
For Metabase to send messages to people, you'll need to set up an email account to send emails via **SMTP** (simple mail transfer protocol). SMTP is an email standard that, when combined with SSL/TLS, provides security protection for emails.
3777

3878
To start, go to the Admin Panel from the dropdown menu in the top right of Metabase, then from the Settings page, click on **Email** in the left menu.
3979

@@ -50,22 +90,22 @@ Here you'll set:
5090
- SSL
5191
- TLS
5292
- STARTTLS
53-
- **SMTP Username**.
54-
- **SMTP Password**.
93+
- **SMTP USERNAME**: Your SMTP account username.
94+
- **SMTP PASSWORD**: Your SMTP account password.
5595

5696
You'll also need to specify your:
5797

5898
- **From address**: The email address you want to use for the sender of emails.
59-
- **Reply-to address**: The email address you want the replies to go to, if different from the from address.
99+
- **Reply-to address**: The email address you want replies to go to, if different from the From address.
60100

61101
## Add recipients as CC or BCC
62102

63103
By default, Metabase will hide email recipients by including them in the BCC list (Blind Carbon Copy) of the email. But if you're having issues with your email provider blocking emails with BCC recipients, and you don't mind having people see who else has been copied on the email Metabase sends them, you can tell Metabase to CC (Carbon Copy) recipients instead.
64104

65105
### Recommended email settings
66106

67-
- SSL is strongly recommended because its more secure and gives your account extra protection from threats.
68-
- If your email service has a whitelist of email addresses that are allowed to send email, be sure to whitelist the email address that you put in the **From Address** field to ensure you and your teammates receive all emails from Metabase.
107+
- SSL is strongly recommended because it's more secure and gives your account extra protection from threats.
108+
- If your email service has a whitelist of email addresses that are allowed to send email, be sure to whitelist the email address that you put in the **From address** field to ensure you and your teammates receive all emails from Metabase.
69109

70110
## Notes for common email services
71111

@@ -75,12 +115,12 @@ By default, Metabase will hide email recipients by including them in the BCC lis
75115

76116
### Google Apps
77117

78-
1. In the **SMTP host** field, enter smtp.gmail.com
79-
2. Fill in 465 for the **SMTP port** field
80-
3. For the **SMTP Security** field, enter **SSL**
81-
4. In the **SMTP username** field, enter your Google Apps email address (e.g. [email protected])
82-
5. Enter your Google Apps password in the **SMTP password** field
83-
6. Enter the email address you would like to be used as the sender of system notifications in the \*_From Address_ field.
118+
1. In the **SMTP HOST** field, enter smtp.gmail.com
119+
2. Fill in 465 for the **SMTP PORT** field
120+
3. For the **SMTP SECURITY** field, enter **SSL**
121+
4. In the **SMTP USERNAME** field, enter your Google Apps email address (e.g. [email protected])
122+
5. Enter your Google Apps password in the **SMTP PASSWORD** field
123+
6. Enter the email address you would like to be used as the sender of system notifications in the **From address** field.
84124

85125
### Amazon SES
86126

@@ -106,7 +146,7 @@ Check if [email quotas](https://docs.aws.amazon.com/ses/latest/dg/quotas.html) a
106146

107147
Allowed email address domain(s) for new [dashboard subscriptions](../dashboards/subscriptions) and [alerts](../questions/alerts).
108148

109-
Adding approved domains allows you to restrict which email addresses people can send alerts and subscriptions to. This restriction only applies to sending email to people who lack an account with that Metabase. People with accounts in a Metabase who aren't [sandboxed](../permissions/data-sandboxes) will be able to email any other person with an account in that same Metabase.
149+
Adding approved domains allows you to restrict which email addresses people can send alerts and subscriptions to. This restriction only applies to sending email to people who lack an account with that Metabase. People with Metabase accounts who aren't [sandboxed](../permissions/data-sandboxes) will be able to email any other person with an account in that same Metabase.
110150

111151
To allow all domains, leave the field empty (allowing all domains is the default).
112152

_docs/master/configuring-metabase/environment-variables.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1722,15 +1722,6 @@ Maximum number of rows to return specifically on :rows type queries via the API.
17221722

17231723
Must be less than 1048575, and less than the number configured in MB_AGGREGATED_QUERY_ROW_LIMIT. See also MB_AGGREGATED_QUERY_ROW_LIMIT.
17241724

1725-
### `MB_UPDATE_CHANNEL`
1726-
1727-
- Type: string
1728-
- Default: `latest`
1729-
- [Exported as](../installation-and-operation/serialization): `update-channel`.
1730-
- [Configuration file name](./config-file): `update-channel`
1731-
1732-
We'll notify you here when there's a new version of this type of release.
1733-
17341725
### `MB_UPLOADS_DATABASE_ID [DEPRECATED]`
17351726

17361727
> DEPRECATED: 0.50.0

_site/docs/master/CONTRIBUTING.html

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1691,7 +1691,35 @@ <h5>Analytics</h5>
16911691

16921692
<li>
16931693
<a href="/docs/master/questions/native-editor/sql-parameters" class="">
1694-
SQL parameters and field filters
1694+
SQL parameters
1695+
</a>
1696+
</li>
1697+
1698+
1699+
<li>
1700+
<a href="/docs/master/questions/native-editor/field-filters" class="">
1701+
Field filters
1702+
</a>
1703+
</li>
1704+
1705+
1706+
<li>
1707+
<a href="/docs/master/questions/native-editor/basic-sql-parameters" class="">
1708+
Basic SQL parameters
1709+
</a>
1710+
</li>
1711+
1712+
1713+
<li>
1714+
<a href="/docs/master/questions/native-editor/optional-parameters" class="">
1715+
Optional variables
1716+
</a>
1717+
</li>
1718+
1719+
1720+
<li>
1721+
<a href="/docs/master/questions/native-editor/filter-widgets" class="">
1722+
Filter widgets
16951723
</a>
16961724
</li>
16971725

_site/docs/master/actions/basic.html

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1691,7 +1691,35 @@ <h5>Analytics</h5>
16911691

16921692
<li>
16931693
<a href="/docs/master/questions/native-editor/sql-parameters" class="">
1694-
SQL parameters and field filters
1694+
SQL parameters
1695+
</a>
1696+
</li>
1697+
1698+
1699+
<li>
1700+
<a href="/docs/master/questions/native-editor/field-filters" class="">
1701+
Field filters
1702+
</a>
1703+
</li>
1704+
1705+
1706+
<li>
1707+
<a href="/docs/master/questions/native-editor/basic-sql-parameters" class="">
1708+
Basic SQL parameters
1709+
</a>
1710+
</li>
1711+
1712+
1713+
<li>
1714+
<a href="/docs/master/questions/native-editor/optional-parameters" class="">
1715+
Optional variables
1716+
</a>
1717+
</li>
1718+
1719+
1720+
<li>
1721+
<a href="/docs/master/questions/native-editor/filter-widgets" class="">
1722+
Filter widgets
16951723
</a>
16961724
</li>
16971725

_site/docs/master/actions/custom.html

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1691,7 +1691,35 @@ <h5>Analytics</h5>
16911691

16921692
<li>
16931693
<a href="/docs/master/questions/native-editor/sql-parameters" class="">
1694-
SQL parameters and field filters
1694+
SQL parameters
1695+
</a>
1696+
</li>
1697+
1698+
1699+
<li>
1700+
<a href="/docs/master/questions/native-editor/field-filters" class="">
1701+
Field filters
1702+
</a>
1703+
</li>
1704+
1705+
1706+
<li>
1707+
<a href="/docs/master/questions/native-editor/basic-sql-parameters" class="">
1708+
Basic SQL parameters
1709+
</a>
1710+
</li>
1711+
1712+
1713+
<li>
1714+
<a href="/docs/master/questions/native-editor/optional-parameters" class="">
1715+
Optional variables
1716+
</a>
1717+
</li>
1718+
1719+
1720+
<li>
1721+
<a href="/docs/master/questions/native-editor/filter-widgets" class="">
1722+
Filter widgets
16951723
</a>
16961724
</li>
16971725

_site/docs/master/actions/introduction.html

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1691,7 +1691,35 @@ <h5>Analytics</h5>
16911691

16921692
<li>
16931693
<a href="/docs/master/questions/native-editor/sql-parameters" class="">
1694-
SQL parameters and field filters
1694+
SQL parameters
1695+
</a>
1696+
</li>
1697+
1698+
1699+
<li>
1700+
<a href="/docs/master/questions/native-editor/field-filters" class="">
1701+
Field filters
1702+
</a>
1703+
</li>
1704+
1705+
1706+
<li>
1707+
<a href="/docs/master/questions/native-editor/basic-sql-parameters" class="">
1708+
Basic SQL parameters
1709+
</a>
1710+
</li>
1711+
1712+
1713+
<li>
1714+
<a href="/docs/master/questions/native-editor/optional-parameters" class="">
1715+
Optional variables
1716+
</a>
1717+
</li>
1718+
1719+
1720+
<li>
1721+
<a href="/docs/master/questions/native-editor/filter-widgets" class="">
1722+
Filter widgets
16951723
</a>
16961724
</li>
16971725

_site/docs/master/actions/start.html

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1691,7 +1691,35 @@ <h5>Analytics</h5>
16911691

16921692
<li>
16931693
<a href="/docs/master/questions/native-editor/sql-parameters" class="">
1694-
SQL parameters and field filters
1694+
SQL parameters
1695+
</a>
1696+
</li>
1697+
1698+
1699+
<li>
1700+
<a href="/docs/master/questions/native-editor/field-filters" class="">
1701+
Field filters
1702+
</a>
1703+
</li>
1704+
1705+
1706+
<li>
1707+
<a href="/docs/master/questions/native-editor/basic-sql-parameters" class="">
1708+
Basic SQL parameters
1709+
</a>
1710+
</li>
1711+
1712+
1713+
<li>
1714+
<a href="/docs/master/questions/native-editor/optional-parameters" class="">
1715+
Optional variables
1716+
</a>
1717+
</li>
1718+
1719+
1720+
<li>
1721+
<a href="/docs/master/questions/native-editor/filter-widgets" class="">
1722+
Filter widgets
16951723
</a>
16961724
</li>
16971725

_site/docs/master/configuring-metabase/appearance.html

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1691,7 +1691,35 @@ <h5>Analytics</h5>
16911691

16921692
<li>
16931693
<a href="/docs/master/questions/native-editor/sql-parameters" class="">
1694-
SQL parameters and field filters
1694+
SQL parameters
1695+
</a>
1696+
</li>
1697+
1698+
1699+
<li>
1700+
<a href="/docs/master/questions/native-editor/field-filters" class="">
1701+
Field filters
1702+
</a>
1703+
</li>
1704+
1705+
1706+
<li>
1707+
<a href="/docs/master/questions/native-editor/basic-sql-parameters" class="">
1708+
Basic SQL parameters
1709+
</a>
1710+
</li>
1711+
1712+
1713+
<li>
1714+
<a href="/docs/master/questions/native-editor/optional-parameters" class="">
1715+
Optional variables
1716+
</a>
1717+
</li>
1718+
1719+
1720+
<li>
1721+
<a href="/docs/master/questions/native-editor/filter-widgets" class="">
1722+
Filter widgets
16951723
</a>
16961724
</li>
16971725

0 commit comments

Comments
 (0)