Skip to content

Commit a9348bf

Browse files
committed
add more _docs versions
1 parent 2dbc59e commit a9348bf

9,217 files changed

Lines changed: 229595 additions & 0 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.

_docs/v0.12/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
version: v0.12
3+
category: 'Table of Contents'
4+
title: README
5+
source_url: 'https://github.com/metabase/metabase/blob/master/docs/README.md'
6+
permalink: /docs/v0.12/index.html
7+
layout: docs
8+
---
9+
10+
## In-depth Guides
11+
12+
#### [Users Guide](users-guide/start.html)
13+
This is the go-to guide on asking questions and sharing answers using Metabase. You'll learn in depth about how questions are expressed, how to chart answers, as well as how to share questions and create dashboards.
14+
15+
#### [Admin Guide](administration-guide/start.html)
16+
This guide is for advanced users and those who will be setting up and maintaining a Metabase installation. You'll learn how to set the instance up, how to configure common settings, how to manage user accounts, and how to add databases. You'll also learn how to troubleshoot common problems with both Metabase as well as underlying databases or data warehouses it uses.
17+
18+
#### [Operations Guide](operations-guide/start.html)
19+
This guide contains more detailed information about how to install Metabase for production use. It covers topics like SSL termination, deploying via Docker Containers vs. Jars, as well as the tradeoffs involved.
20+
21+
22+
## For Developers
23+
24+
#### [Developers Guide](developers-guide.html)
25+
This guide covers how to contribute back to the Metabase open source project. It includes setting up a development environment, running tests, and the contribution and product process Metabase follows.
26+
27+
28+
## Reference
29+
30+
#### [Anonymous Information Collection Reference](information-collection.html)
31+
This describes the anonymous usage information we collect (if you opt-in) as well as why we collect it and the ways we use it.
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
version: v0.12
3+
category: Administration-Guide
4+
title: '01 Managing Databases'
5+
source_url: 'https://github.com/metabase/metabase/blob/master/docs/administration-guide/01-managing-databases.md'
6+
layout: docs
7+
---
8+
9+
## Managing Databases
10+
If you already connected your database during the installation, you’ve probably a covered a lot of this info. But if you need to add another database or manage the settings of the one you already have connected, just click the circle with your initials in the top right of Metabase and select the **Admin Panel**.
11+
12+
![profiledropdown](images/ProfileDropdown.png)
13+
14+
Cool, now you’re in the admin panel. Next, select **Databases** from the menu bar at the top of the screen to see your databases.
15+
16+
### Adding a Database Connection
17+
18+
Now you’ll see a list of your databases. To connect another database to Metabase, click **Add database**. Metabase currently supports the following types of databases:
19+
20+
* H2
21+
* MongoDB
22+
* MySQL
23+
* Postgres
24+
25+
To add a database, you'll need its connection information.
26+
27+
#### <a name="heroku-databases"></a>Getting connection information for Databases on Heroku:
28+
29+
1. Go to [https://postgres.heroku.com/databases](https://postgres.heroku.com/databases).
30+
2. Click on the database you want to connect to Metabase.
31+
3. Write down the following information based on your database:
32+
* Hostname
33+
* Port
34+
* Username
35+
* Database Name
36+
* Password
37+
38+
#### <a name="rds-databases"></a>Getting connection information for Databases on Amazon's RDS:
39+
40+
1. Go to your AWS Management Console.
41+
* Need help finding that? Visit [https://**My_AWS_Account_ID**.signin.aws.amazon.com/console](https://**My_AWS_Account_ID**.signin.aws.amazon.com/console). Be sure to insert your own AWS Account ID, though!
42+
2. Under "Database" services, click "RDS".
43+
3. Then click "Instances".
44+
4. Select the database you want to connect to Metabase.
45+
5. Write down the following information based on your database:
46+
* Hostname - This is listed as the "Endpoint" parameter
47+
* Port - Find the port parameter under "Security and Network"
48+
* Username - Find this under "Configuration Details"
49+
* Database Name - Find this under "Configuration Details"
50+
* Password - Ask your database administrator for the password.
51+
52+
53+
### Secure Socket Layer (SSL)
54+
55+
Metabase automatically tries to connect to databases with and without SSL. If it is possible to connect to your database with a SSL connection, Metabase will make that the default setting for your database. You can always change this setting later if you prefer to connect without this layer of security, but we highly recommend keeping SSL turned on to keep your data secure.
56+
57+
### Database Analysis
58+
59+
When Metabase connects to your database, it tries to decipher the field types in your tables based on each field's name. Metabase also takes a sample of each table to look for URL's, json, encoded strings, etc. If a field is classified wrong, you can always manually edit it from the **Metadata** tab in the Admin Panel.
60+
61+
### Metadata Syncing
62+
63+
Metabase automatically syncs its copy of your database with the original database source every night, but if you'd like to sync your database manually at any time:
64+
65+
1. Go to the Admin Panel.
66+
67+
2. Select **Databases** from the navigation menu.
68+
![adminbar](images/AdminBar.png)
69+
70+
3. Click on the database you would like to sync.
71+
![databaselist](images/DatabaseList.png)
72+
73+
4. Click on the **Sync** button on the right of the screen.
74+
![databaseconnection](images/DatabaseConnection.png)
75+
76+
### Deleting Databases
77+
78+
To delete a database from Metabase, click on **Remove this database** from the database detail screen.
79+
80+
![databaseconnection](images/DatabaseConnection.png)
81+
82+
You can also delete a database from the database list: hover over the row with the database you want to remove and click the **Delete** button that appears.
83+
84+
![deletedatabasebutton](images/DatabaseDeleteButton.png)
85+
86+
**Caution: Deleting a database is irreversible! All saved questions and dashboard cards based on the database will be deleted as well!**
87+
88+
---
89+
## Next: enabling features that send email
90+
Metabase can send emails for certain features, like email invites, but first you need to [set up an email account](02-setting-up-email.html).
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
version: v0.12
3+
category: Administration-Guide
4+
title: '02 Setting Up Email'
5+
source_url: 'https://github.com/metabase/metabase/blob/master/docs/administration-guide/02-setting-up-email.md'
6+
layout: docs
7+
---
8+
9+
## Setting up Email
10+
11+
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.
12+
13+
### Configuring your Email Account
14+
15+
For Metabase to send and receive 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.
16+
17+
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.
18+
19+
You should see this form:
20+
21+
![Email Credentials](images/EmailCredentials.png)
22+
23+
**If you use Google Apps:**
24+
* In the **SMTP host** field, enter smtp.gmail.com
25+
* Fill in 465 for the **SMTP port** field
26+
* For the **SMTP Security** field, enter **TLS**
27+
* In the **SMTP username** field, enter your Google Apps email address (e.g. hello@yourdomain.com)
28+
* Enter your Google Apps password in the **SMTP password** field
29+
* Enter the email address you would like to be used as the sender of system notifications in the **From Address* field.
30+
31+
**If you use Amazon SES:**
32+
* Log on to [https://console.aws.amazon.com/ses](https://console.aws.amazon.com/ses).
33+
* Click **SMTP Settings** from the navigation pane.
34+
* Select **Create My SMTP Credentials** in the content pane.
35+
* Create a user in the **Create User for SMTP** dialog box and then click **Create**.
36+
* Next, select **Show User SMTP Credentials** to view the user's SMTP credentials.
37+
* Go back to the Metabase Admin Panel form and enter the info there.
38+
39+
**If you use Mandrill:**
40+
* Log in to your Mandrill account and locate your credentials from the **SMTP & API Info** page there.
41+
* Your SMTP password is any active API key for your account — *not* your Mandrill password.
42+
* Although Mandrill lists **port 587**, [any port supported by Mandrill](https://mandrill.zendesk.com/hc/en-us/articles/205582167-What-SMTP-ports-can-I-use-) will work for SMTP email.
43+
* Now you can go back to the Metabase Admin Panel form and enter the info there.
44+
45+
**No matter which email provider you use,**
46+
* SSL is strongly recommended because it’s more secure and gives your account extra protection from threats.
47+
* 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.
48+
49+
---
50+
## Next: editing your metadata
51+
Taking just a few minutes to edit and add info to your database’s metadata can greatly enhance your experience with Metabase. Let’s learn [how to edit your metadata](03-metadata-editing.html).
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
version: v0.12
3+
category: Administration-Guide
4+
title: '03 Metadata Editing'
5+
source_url: 'https://github.com/metabase/metabase/blob/master/docs/administration-guide/03-metadata-editing.md'
6+
layout: docs
7+
---
8+
9+
## Metadata Editing
10+
11+
### What is metadata?
12+
Metadata is data about other data. It's information that tells you about the data found in your database. For example, we could label a field that looks like just a bunch of numbers with the label “latitude,” which would give that field additional meaning and context.
13+
14+
Metabase allows you to optionally annotate the data in your database, which provides Metabase with an understanding of what the data actually means and allows it to more intelligently process and display it for you.
15+
16+
### Editing your database’s metadata
17+
All of these settings are editable via the **Metadata** page within the **Admin Panel**. To get there, click the dropdown in the top right of Metabase that shows your initials, and select **Admin Panel**. Then click on **Metadata** from the top menu.
18+
19+
In the column on the left, you can choose which database to view, and then select the table whose metadata you want to view and edit.
20+
21+
You can edit metadata for two things: tables and fields.
22+
23+
### Metadata for tables
24+
Tables can either be set to **Queryable** or **Hidden**. Queryable tables can be selected from the question builder, and all of the data in the table can be displayed (unless certain fields are excluded — more on that below).
25+
26+
Hidden tables can’t be selected from the query builder, and their data can’t be accessed.
27+
28+
You can also change the name and description of your tables here. Note that the underlying database won’t be affected — this will only change the name of the table while you’re viewing it within Metabase. Add descriptions to tables to let people know type of data a table contains and how it can be used. Descriptions are displayed in the data model reference panel in Metabase, which you can view by clicking the book icon in the top right of a new or saved question page.
29+
30+
If you ever want to see the original underlying schema for a given table, just click the **Show original schema** toggle in the top-right of the screen.
31+
32+
33+
### Metadata for fields
34+
35+
A field is a representation of either a column (when using a SQL based database, like PostgreSQL) or a field in a document (when using a document- or JSON-based database like MongoDB). Metabase automatically attempts to classify your fields and assign them a type. If Metabase misclassified any fields, you can correct that here.
36+
37+
There are several pieces of metadata you can edit per field: name, description, visibility, type, and details:
38+
39+
#### Name
40+
41+
Clicking on the name of the field allows you to change how the field name is displayed. For example, if your ORM produces table names like “auth.user", you can replace this with “User” to make it more readable. Again, this only changes how the field is displayed in Metabase.
42+
43+
#### Description
44+
45+
This is a human-readable description of what the field is and how it is meant to be used. Any caveats about interpretation can go here as well. Descriptions are extra helpful when fields have values that are abbreviated or coded in a particular format.
46+
47+
#### Visibility
48+
49+
If you have really long data in certain fields, like descriptions or biographies, you can set the visibility to display the field **Only in Detail Views** when looking at a single record. By default, any column with an average length of longer than 50 characters is assigned this setting.
50+
51+
Similarly, if you have sensitive or irrelevant fields, you can set them to **Do Not Include**, preventing the field from being accessed by Metabase.
52+
53+
#### Types
54+
55+
**Type** assigns a field a high-level category, and changes how the field can be used within Metabase. For example, only Metric fields can be added or averaged. A field can be assigned one of four basic types:
56+
57+
* Metric — a metric is a number that you expect to plot, sum, take averages of, etc. You could think of it as anything that would end up being plotted on the y-axis of a graph.
58+
* Dimension — This is any field that you expect to use as an x-axis of a graph or as part of a pivot table. Anything that you could group your results by could be called a dimension, such as dates.
59+
* Information — This is any other information that is not expected to be used in any kind of aggregate metrics but contains other information. Examples include descriptions, names, emails.
60+
* Sensitive Information — Use this setting for fields that you don’t want to show up anywhere in Metabase. This does the same thing as changing the visibility to Do Not Include, and in fact if you set a field’s visibility to Do Not Include, it’ll automatically get assigned the type Sensitive Information.
61+
62+
#### Details
63+
64+
A field’s detailed type is used to determine how to display it, and can also give certain types of fields special functionality. For example, by marking fields in a table as Latitude and Longitude, you allow the table to be used to create pin and heat maps. Similarly, marking a field as a URL allows users to click on it and go to that URL.
65+
66+
This is also where you can set a field to be a **primary key** or **foreign key** of a table.
67+
68+
Common detailed types include:
69+
70+
* Avatar Image URL
71+
* Category
72+
* City
73+
* Country
74+
* Description
75+
* Foreign Key
76+
* Entity Key
77+
* Image URL
78+
* Field containing JSON
79+
* Latitude
80+
* Longitude
81+
* Entity Name
82+
* Number
83+
* State
84+
* URL
85+
* Zip Code
86+
87+
This is also where you set mark special fields in a table:
88+
* Entity Key — the field in this table that uniquely identifies each row. Could be a product ID, serial number, etc.
89+
* Entity Name — different from the entity key, this is the field whose heading represents what each row in the table *is*. For example, in a Users table, the User column might be the entity name.
90+
* Foreign Key — this is a field in this table that uniquely identifies a *row* in another table. In other words, this is a field that, almost always, points to the primary key of another table. For example, in a Products table, you might have a Customer ID field that points to a Customers table, where Customer ID is the primary key.
91+
92+
93+
94+
---
95+
## Next: managing users
96+
Let’s learn how to add, remove, and edit users in the [managing users section](04-managing-users.html).
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
version: v0.12
3+
category: Administration-Guide
4+
title: '04 Managing Users'
5+
source_url: 'https://github.com/metabase/metabase/blob/master/docs/administration-guide/04-managing-users.md'
6+
layout: docs
7+
---
8+
9+
## Managing User Accounts
10+
11+
To start managing users, first go to the **Admin Panel** by clicking on the dropdown menu in the top right of Metabase and selecting Admin Panel.
12+
13+
![Profile dropdown](images/ProfileDropdown.png)
14+
15+
Select **People** from the menu bar at the top of the screen to see a list of all the user accounts in your organization.
16+
17+
![Admin menu](images/AdminBar.png)
18+
19+
### Adding a new user
20+
To add a new user account, click **Add person** in the upper right corner. You’ll be prompted to enter their name and email address.
21+
22+
If you’ve already [configured Metabase to use email](02-setting-up-email.html), Metabase will send the new user an invite email. Otherwise, it’ll give you a temporary password that you’ll have to send to the person you’re inviting by hand.
23+
24+
### Removing a user
25+
To delete a user's account, click on the three dots icon on the right of a user’s row and select **Remove** from the dropdown. Deleting an account will mark it as inactive and prevent it from being used in the future - but it *won’t* delete that user's saved questions or dashboards.
26+
27+
![Remove a user](images/RemoveUser.png)
28+
29+
### Editing a user
30+
You can edit a user’s name and email address by clicking the three dots icon and choosing **Edit Details**. Note: be careful when changing a user’s email address, because *this will change the address they’ll use to log in to Metabase*.
31+
32+
### Resetting a user’s password
33+
A user can always reset their password using the forgot password link on the login screen, but if you want to do this for them, just click the three dots icon and choose Reset Password. If you haven’t configured your email settings yet, you’ll be given a temporary password that you’ll have to share with that user. Otherwise, they’ll receive a password reset email.
34+
35+
### Changing a user’s role
36+
Right now, the only role a user can have is either User or Admin. The only difference is that Admins can access the Admin Panel and make changes there.
37+
38+
To change a user’s role, just click on it to open a dropdown and make your selection.
39+
40+
---
41+
## Next: configuring Metabase
42+
There are a few other settings you configure in Metabase. [Learn how](06-configuration-settings.html).
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
version: v0.12
3+
category: Administration-Guide
4+
title: '06 Configuration Settings'
5+
source_url: 'https://github.com/metabase/metabase/blob/master/docs/administration-guide/06-configuration-settings.md'
6+
layout: docs
7+
---
8+
9+
## Settings
10+
Here are a few other miscellaneous settings you can configure from the home page of the **Admin Panel**.
11+
12+
### Site Name
13+
How you’d like to refer to this instance of Metabase.
14+
15+
### Site URL
16+
The base URL of this Metabase instance. The base URL is used in emails to allow users to click through to their specific instance. Make sure to include http:// or https:// to make sure it’s reachable.
17+
18+
### Report Timezone
19+
The **report timezone** sets the default time zone for displaying times. The timezone is used when breaking out data by dates.
20+
21+
*Setting the default timezone will not change the timezone of any data in your database*. If the underlying times in your database aren't assigned to a timezone, Metabase will use the report timezone as the default timezone.
22+
23+
### Anonymous Tracking
24+
This option turns determines whether or not you allow anonymous data about your usage of Metabase to be sent back to us to help us improve the product. *Your database’s data is never tracked or sent*.
5.03 KB
Loading
1.76 KB
Loading
9.35 KB
Loading
7.05 KB
Loading

0 commit comments

Comments
 (0)