Skip to content

Commit d8549ce

Browse files
committed
things are mostly working + copy all of latest
1 parent e008481 commit d8549ce

591 files changed

Lines changed: 32858 additions & 18 deletions

File tree

Some content is hidden

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

_config.yml

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,19 @@
1919
# in the templates via {{ site.myvariable }}.
2020

2121
title: Metabase Docs
22+
2223
email: info@metabase.com
24+
2325
description: >- # this means to ignore newlines until "baseurl:"
24-
Write an awesome description for your new site here. You can edit this
25-
line in _config.yml. It will appear in your document head meta (for
26-
Google search results) and in your feed.xml site description.
27-
baseurl: "" # the subpath of your site, e.g. /blog
28-
url: "" # the base hostname & protocol for your site, e.g. http://example.com
26+
Metabase Documentation: your comprehensive guide to mastering business
27+
intelligence, dashboards, and data visualization. Dive into detailed guides,
28+
step-by-step tutorials, and best practices that empower you to leverage open
29+
source, no SQL tools for uncovering insights and transforming data.
30+
31+
url: "https://docs.metabase.com"
32+
2933
twitter_username: metabase
34+
3035
github_username: metabase
3136

3237
highlighter: rogue
@@ -41,15 +46,6 @@ whitelist:
4146

4247
markdown: kramdown
4348

44-
# Exclude from processing.
45-
# The following items will not be processed, by default.
46-
# Any item listed under the `exclude:` key here will be automatically added to
47-
# the internal "default list".
48-
#
49-
# Excluded items can be processed by explicitly listing the directories or
50-
# their entries' file path in the `include:` list.
51-
#
52-
5349
exclude:
5450
- .sass-cache/
5551
- .jekyll-cache/
@@ -75,4 +71,4 @@ defaults:
7571
values:
7672
layout: new-docs
7773
version: "latest"
78-
permalink: "/:path/"
74+
permalink: ":collection/:path"
Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
title: Accounts and billing
3+
version: latest
4+
has_magic_breadcrumbs: true
5+
show_category_breadcrumb: true
6+
show_title_breadcrumb: true
7+
category: Cloud
8+
layout: new-docs
9+
latest: true
10+
---
11+
12+
# Accounts and billing
13+
14+
Managing billing and accounts in the Metabase Store.
15+
16+
## Try out a free 14-day trial of Pro
17+
18+
If you're on a [Starter](/product/starter) cloud plan, you can try out [all the features of Metabase Pro](/product/pro) for free for 14 days with no commitment.
19+
20+
If you want to stick with Pro, you'll have the chance to upgrade. Otherwise, your plan will automatically switch back to Starter.
21+
22+
1. Log in to your Metabase [Store account](https://store.metabase.com).
23+
2. In the **Instances** section, select your instance.
24+
3. Click on **Try a free 14-day trial of Pro**.
25+
26+
Once selected, the Store will display the status of your trial, along with a trial end date. We'll also send you an email with details about the trial.
27+
28+
If you like the Pro features and want to upgrade, you'll need to upgrade your instance, either by clicking on the **Upgrade to Pro** button, or by managing your plan (see the next section).
29+
30+
## Upgrade to Pro (or downgrade to Starter)
31+
32+
If you'd like to switch plans:
33+
34+
1. Log in to your Metabase [Store account](https://store.metabase.com).
35+
2. In the **Instances** section, select the instance you want to change.
36+
3. Click on **Manage plan**.
37+
4. Select the plan you want.
38+
5. Click **Change plan**.
39+
40+
## Add people to manage your Metabase Store account
41+
42+
You can add people to your account to allow them to manage your Metabase Store account (not your Metabase instance).
43+
44+
1. Log in to your Metabase [Store account](https://store.metabase.com).
45+
2. Go to **Settings**.
46+
3. Scroll to **Managers**.
47+
4. Enter email address of the person(s) you'd like to invite.
48+
5. The Store will send them an email prompting them to create a Metabase Store account.
49+
50+
## Add people to receive billing and/or technical notifications
51+
52+
You can include contacts to receive billing notifications, as well as technical notifications, like info about new Metabase releases.
53+
54+
1. Log in to your Metabase [Store account](https://store.metabase.com).
55+
2. Go to **Settings**.
56+
3. Scroll to **Contacts**.
57+
4. Enter email address of the person(s) you'd like to invite.
58+
5. The Store will send them an email notifying them that they've been added to Metabase's contact list.
59+
60+
## Cancel a subscription or trial
61+
62+
To cancel a Starter or Pro plan directly in the Metabase Store:
63+
64+
1. Log in to your Metabase [Store account](https://store.metabase.com).
65+
2. Go to **Instances**.
66+
3. Under the instance with the subscription that you want to cancel, click **Cancel subscription and delete instance**. If you're on an Enterprise plan, you'll need to [contact support](/help-premium).
67+
68+
## Update payment information
69+
70+
1. Log in to your Metabase [Store account](https://store.metabase.com).
71+
2. Navigate to **Billing**.
72+
3. Click on the payment method that you want to update.
73+
4. Enter new credit card information.
74+
5. Click on **Update**.
75+
76+
If your Metabase was suspended due to a failed payment, the Store will automatically restore your Metabase upon a successful payment.
77+
78+
## Switch to annual billing
79+
80+
1. Log in to your Metabase [Store account](https://store.metabase.com).
81+
2. Go to **Instances**.
82+
3. Navigate to the instance you want to switch to annual billing.
83+
4. Click on **Manage plan** next to the plan name.
84+
5. Confirm the plan selection and toggle on **Switch to annual billing**.
85+
6. Click on **Switch plan**.
86+
87+
Note that you cannot switch back to monthly billing until your annual cycle has completed.
88+
89+
## Download past invoices
90+
91+
1. Log in to your Metabase [Store account](https://store.metabase.com).
92+
2. Go to **Billing**.
93+
3. Scroll down to **Invoices** to view past or open invoices.
94+
95+
## W-9 form requests
96+
97+
See Metabase's updated [W9 form](/docs/w9).
98+
99+
## Update your Tax ID
100+
101+
1. Log in to your Metabase [Store account](https://store.metabase.com).
102+
2. Go to on **Billing**.
103+
3. Click on **Invoice Tax IDs**.
104+
4. Enter your country and Tax ID.
105+
5. Click **Save**.
106+
107+
## Change the company name on invoices/receipts
108+
109+
The primary account holder should request a name change by emailing [billing@metabase.com](mailto:billing@metabase.com).
110+
111+
## Reset your Admin password
112+
113+
If you need to reset your Admin password, [contact support](/help-premium).
114+
115+
## Change your company name
116+
117+
1. Navigate to your Metabase Store.
118+
2. Go to **Settings**.
119+
3. Click **Change company name**.
120+
121+
## Change your billing address
122+
123+
1. Navigate to your Metabase Store.
124+
2. Go to **Billing**.
125+
3. Click on **Billing address**.
126+
4. Update your billing address.
127+
5. Click **Save**.
128+
129+
### Add or change your shipping address
130+
131+
1. Navigate to your Metabase Store.
132+
2. Go to **Billing**.
133+
3. Click on **Shipping address**.
134+
4. Add or update your shipping address.
135+
5. Click **Save**.
136+
137+
## Change the primary account holder
138+
139+
If you need to change your primary account holder, for example if your primary account holder left your company:
140+
141+
- If another person at your company holds a Metabase Store account, work with them to add you to your company's Metabase Store account.
142+
- If there is no other account holder, email [billing@metabase.com](mailto:billing@metabase.com) to request access to your company's Metabase Store account. Please note that if the primary account holder is unavailable, there is a 48-hour waiting period to process changes to Metabase Store accounts.
143+
144+
## Move from Metabase Cloud to self-hosting Metabase
145+
146+
If you're on Metabase Cloud but need to switch to hosting Metabase yourself, [contact us](/help-premium) and we'll give you a backup of your application database that you can use to restore Metabase on your own infrastructure.
147+
148+
## Further reading
149+
150+
- [How billing works](./how-billing-works)
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Changing which region your Metabase is hosted in
3+
version: latest
4+
has_magic_breadcrumbs: true
5+
show_category_breadcrumb: true
6+
show_title_breadcrumb: true
7+
category: Cloud
8+
layout: new-docs
9+
latest: true
10+
---
11+
12+
# Changing which region your Metabase is hosted in
13+
14+
You may want to change which region your Metabase is hosted in to bring it closer to the people using it
15+
16+
- [Plan for some down time](#plan-for-some-down-time)
17+
- [Select a region](#select-a-region)
18+
- [Add the relevant IP addresses to your whitelist](#add-the-relevant-ip-addresses-to-your-whitelist)
19+
- [If your Metabase uses a custom domain, update your CNAMES](#if-your-metabase-uses-a-custom-domain-update-your-cnames)
20+
21+
## Plan for some down time
22+
23+
Most region switches should take less than 30 minutes. Your Metabase will be offline and unavailable while it changes regions, so plan for some down time.
24+
25+
If you're using a [custom domain](./custom-domain), that region change could take longer, maybe up to 24 hours. That delay is due to DNS propagation (which is out of our hands).
26+
27+
## Select a region
28+
29+
To change regions, go to your [Metabase Store page](https://store.metabase.com/) and click on **Instances**. In the **Hosting regions** section, select the region you want to choose from:
30+
31+
- US East (North Virginia)
32+
- Europe (Frankfurt)
33+
- Asia Pacific (Singapore)
34+
- South America (São Paulo)
35+
36+
## Add the relevant IP addresses to your whitelist
37+
38+
If you're using a security group or firewall rules, you should add the relevant [IP addresses](./ip-addresses-to-whitelist) to your whitelist.
39+
40+
## If your Metabase uses a custom domain, update your CNAMES
41+
42+
If your Metabase uses a [custom domain](./custom-domain), you'll need to update your CNAMES. DNS switches are generally fast these days, but it'll take some time to sign a new certificate for that domain once it's updated (up to 24 hours).
43+
44+
We recommend switching regions during a time when people are less likely to use your Metabase.
45+
46+
## Need help?
47+
48+
No need to worry about backups (we have you covered), but if you run into any issues, contact support at [help@metabase.com](mailto:help@metabase.com).
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Metabase Cloud versus self-hosting
3+
version: latest
4+
has_magic_breadcrumbs: true
5+
show_category_breadcrumb: true
6+
show_title_breadcrumb: true
7+
category: Cloud
8+
layout: new-docs
9+
latest: true
10+
---
11+
12+
# Metabase Cloud versus self-hosting
13+
14+
We have a post that goes into more depth on [why Metabase Cloud might be right for you](/blog/why-metabase-cloud), but here's a (nonexhaustive) table listing some of the differences between Metabase Cloud and self-hosting Metabase.
15+
16+
| | Self-hosted OSS | Metabase Cloud |
17+
| ------------------------------ | ----------------------------------- | ------------------ |
18+
| High availability servers | ~\$48+/month ||
19+
| Load balancer | ~\$12+/month ||
20+
| Managed database | ~\$40-60+/month ||
21+
| SMTP server | ~\$12+/month ||
22+
| Support | Forum only (paid plans get support) | Email with SLA |
23+
| Up and running in minutes | Manual ||
24+
| Upgrades | Manual ||
25+
| Multi-zone availability | Manual ||
26+
| Backups | Manual ||
27+
| Monitoring | Manual ||
28+
| Keep your own fork of the code |||
29+
| SoC2 Type 2 security auditing | Manual ||
30+
| SSL certificate | Manual ||
31+
| Where your money goes | 3rd-party companies | Improving Metabase |
32+
33+
Infrastructure costs are tricky to estimate, so keep in mind that the above self-hosting prices are ballpark estimates for a comparable setup with other cloud providers. If you _really_ know what you're doing, you can price out a cheaper setup, but then the services aren't managed and you don't get official support (which alone might make Cloud the better choice). We're just trying to provide an anchor to compare against for a similar production-grade setup, and anyway, you can always start out with Cloud and move to self-hosting whenever.
34+
35+
## When _should_ you self-host?
36+
37+
There are some cases where you _should_ self-host.
38+
39+
- You need an [air-gapped environment](/product/air-gapping), usually for regulatory compliance, or if you’re running your own three-letter-agency… If you’re not sure if you need an air-gapped environment, you don’t need an air-gapped environment. If you do need an air-gap, we have an [air-gap offering as well](/talk-to-a-person/) (just not for Cloud, obviously).
40+
- You have some regulations that stipulate how you run your software (like HIPAA).
41+
- You want to run a custom build of Metabase. That is, you’re running a fork of Metabase (OSS or the Enterprise/Pro version) so you can add your own customizations to the software, and you have the engineering resources to tank that level of overhead.
42+
- You want to use a community or custom driver. We only support [official (1st-party) and partner drivers](/docs/latest/databases/connecting#connecting-to-supported-databases) on Metabase Cloud, because we need to be able to vouch for their quality and help you with problems in a production context.
43+
44+
Otherwise, you're better off having us handle all of the overhead so you can focus on your business. The official support alone is probably worth it.
45+
46+
## Metabase Pro and Enterprise
47+
48+
Metabase also has a paid version that ships with all of the bells and whistles (SSO, row-level permissions, customization, and a lot more). Plans with this version include:
49+
50+
- [Metabase Pro](/product/pro)
51+
- [Metabase Enterprise](/product/enterprise)
52+
53+
You can self-host this paid version, or have have us host it for you on Metabase Cloud for no additional cost. We don't charge more because we believe you'll have such a better experience that it'll be easier for us to support you.
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: Changing your domain name
3+
version: latest
4+
has_magic_breadcrumbs: true
5+
show_category_breadcrumb: true
6+
show_title_breadcrumb: true
7+
category: Cloud
8+
layout: new-docs
9+
redirect_from:
10+
- /cloud/docs/custom-domain
11+
latest: true
12+
---
13+
14+
# Changing your domain name
15+
16+
By default, Metabase will automatically provision a domain name for your Metabase that ends in metabaseapp.com (e.g., yourcompany.metabaseapp.com).
17+
18+
[Pro and Enterprise](/pricing/) plans allow you to add a custom domain. Setting a custom domain will update your instance's [Site URL](/docs/latest/configuring-metabase/settings#site-url). The Site URL is used for things like creating links in emails, auth redirects, and in some embedding scenarios.
19+
20+
## How to add a custom domain to your Metabase
21+
22+
1. Log in to your [Metabase Store account](https://store.metabase.com/).
23+
24+
2. Find the Metabase instance that you want to add the custom domain to, and select **Manage** on the bottom right of the instance's card. Then click on the **Domains** tab.
25+
26+
You'll see something like this:
27+
28+
![Metabase instance domains tab](./images/domains-tab.png)
29+
30+
3. In the custom domain field (the input prefixed with `https://` in the Metabase Store), enter your custom domain (e.g., your.custom.domain).
31+
4. Talk to whoever manages your Domain Name System (DNS) records, and have them add a CNAME to wherever you manage your DNS records. Point that CNAME to this URL:
32+
33+
```url
34+
us-1.cd.metabaseapp.com
35+
```
36+
37+
So your CNAME record would look something like:
38+
39+
```domain
40+
CNAME your.custom.domain us-1.cd.metabaseapp.com
41+
```
42+
43+
Just to be clear: you don't enter this record in the Metabase Store; you enter it in wherever you manage your DNS records.
44+
45+
5. If you've already set up SSO (like SAML or LDAP) for your Metabase, you'll need to update the return URL in your identity provider configuration to include this new custom domain.
46+
47+
That's it. You may need to wait a bit for the CNAME to update (this delay is specific to how DNS works, and not something Metabase has control over). Metabase will take care of the rest: we'll make sure that:
48+
49+
- the URL directs people to your Metabase,
50+
- your domain has SSL certificates set up to serve your instance over HTTPS to the new domain,
51+
- and that your [metabase.com/cloud/login](/cloud/login) works as expected.
52+
53+
You'll still be able to access your original, automatically provisioned domain (e.g., yourcompany.metabaseapp.com), so existing embedded links should continue to work.
54+
55+
## Why you'd want to use a custom domain
56+
57+
- **White-labeling polish**: If you're white labeling Metabase, a custom domain adds another bit of polish that abstracts Metabase away from the experience you deliver to your customers.
58+
- **Consistency**: you may have several internal tools that follow a pattern, e.g., crm.yourcompany.com, ops.yourcompany.com, etc., and you want something like stats.yourcompany.com for your Metabase.
59+
60+
## Change the name of your Metabase (your DNS alias)
61+
62+
Log in to your Metabase Store account and go to **Instances** > **DNS Alias**, where you can update your alias.

0 commit comments

Comments
 (0)