Skip to content
Snippets Groups Projects
Commit a06d9078 authored by Allen Gilliland's avatar Allen Gilliland
Browse files

Merge pull request #1600 from metabase/doc_updates_for_0.13

Doc updates for 0.13
parents 4b405003 253e2c29
Branches
Tags
No related merge requests found
Showing
with 312 additions and 107 deletions
......@@ -10,10 +10,13 @@ Cool, now you’re in the admin panel. Next, select **Databases** from the menu
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:
* Amazon Redshift
* H2
* MongoDB
* MySQL
* Postgres
* SQLite
* SQL Server
To add a database, you'll need its connection information.
......
......@@ -5,7 +5,7 @@ Once you connect your database to Metabase, you'll want to configure an email ac
### Configuring your Email Account
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.
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.
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.
......@@ -22,9 +22,9 @@ You should see this form:
* Enter the email address you would like to be used as the sender of system notifications in the **From Address* field.
**If you use Amazon SES:**
* Log on to [https://console.aws.amazon.com/ses](https://console.aws.amazon.com/ses).
* Log on to [https://console.aws.amazon.com/ses](https://console.aws.amazon.com/ses).
* Click **SMTP Settings** from the navigation pane.
* Select **Create My SMTP Credentials** in the content pane.
* Select **Create My SMTP Credentials** in the content pane.
* Create a user in the **Create User for SMTP** dialog box and then click **Create**.
* Next, select **Show User SMTP Credentials** to view the user's SMTP credentials.
* Go back to the Metabase Admin Panel form and enter the info there.
......
......@@ -15,3 +15,8 @@ The **report timezone** sets the default time zone for displaying times. The tim
### Anonymous Tracking
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*.
---
## Next: Setting up Slack
If you want to use Slack to enhance the Metabase experience then lets do that now. Let’s learn [how to setup Slack](07-setting-up-slack.md).
## Setting up Slack
If you are using Slack for team communication and would like to have your Pulses be sent to Slack channels (or users) then you'll need to integrate your Metabase instance with Slack. Luckily, this is really easy!
### Generating a Slack API Token
For Metabase to post to your Slack channels, you'll need to generate a Slack API token and make it available to Metabase.
To start, go to the Admin Panel from the dropdown menu in the top right of Metabase, then from the Settings page, click on **Slack** in the left menu.
You should see this form:
![Slack Settings](images/SlackSettings.png)
Then just click on the large and conveniently placed button `Get an API token from Slack` which will open a new browser tab and send you over to Slack to create the token.
Click over to the tab that was opened and you'll now be on the Slack API page under the Authentication section which will show you any API tokens that you have created for your various Slack teams.
![Slack API Auth](images/SlackAPIAuth.png)
Now just click the `Create token` button next to the team you want to integrate with and a token will be generated for you. It will look like `xoxp-etc-etc-etc` and all you need to do is copy that value and head back to Metabase.
Paste the value into the text box for `Slack API Token` and click the button to save your changes. That's it! Metabase will automatically run a quick test to check that the API token is working properly and if not you'll get an error message.
docs/administration-guide/images/EmailCredentials.png

122 KiB | W: | H:

docs/administration-guide/images/EmailCredentials.png

124 KiB | W: | H:

docs/administration-guide/images/EmailCredentials.png
docs/administration-guide/images/EmailCredentials.png
docs/administration-guide/images/EmailCredentials.png
docs/administration-guide/images/EmailCredentials.png
  • 2-up
  • Swipe
  • Onion skin
docs/administration-guide/images/SlackAPIAuth.png

334 KiB

docs/administration-guide/images/SlackSettings.png

117 KiB

......@@ -9,6 +9,7 @@ Are you in charge of managing Metabase for your organization? Then you're in the
* [Edit your database metadata](03-metadata-editing.md)
* [Manage user accounts](04-managing-users.md)
* [Configure settings](06-configuration-settings.md)
* [Setting up Slack Integration](07-setting-up-slack.md)
First things first, you'll need to install Metabase. If you haven’t done that yet, our [Installation Guide](../operations-guide/start.md#installing-metabase) will help you through the process.
......
docs/images/NewsletterSignup.png

182 KiB

## Backing up Metabase Application Data
If you are using Metabase in a production environment or simply want to make sure you don't lose any of the work that you've done, then backups are what you need.
Metabase uses a single SQL database for all of its runtime application data, so all you need to do is backup that database and you're good to go. From a database back-up you can restore any Metabase installation.
### H2 Embedded Database (default)
If you launched Metabase on a laptop or PC the application will create an embedded H2 database in the directory it is being run in. Navigate to the directory where you started Metabase from and find the file named `metabase.db.h2.db`. Simply copy that file somewhere safe and you are all backed up!
NOTE: If your Metabase is currently running it's best to shut down the Metabase process before making a backup copy of the file. Then, restart the application.
### Amazon RDS for the Database Application
Amazon has its own best practices on how to backup and restore RDS databases, so we'll defer to them. We recommend that you enable automated RDS Backups.
Instructions can be found in the [Amazon RDS User Guide](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html).
### Self-managed PostgreSQL or MySQL database
Simply follow the same instructions you would use for making any normal database backup. It's a large topic more fit for a DBA to answer, but as long as you have a dump of the Metabase database you'll be good to go.
> **Covered in this guide:**
> [Installing Metabase on AWS Elastic Beanstalk](#running-metabase-on-aws-elastic-beanstalk)
> [Upgrading to new versions of Metabase](#deploying-new-versions-of-metabase)
> [Retaining Metabase logs on S3](#retaining-metabase-logs)
> [Running Metabase over HTTPS](#running-metabase-over-https)
> [Using Papertrail for logging](#running-metabase-with-papertrail-on-aws)
> [Protecting invalid hostname access](#protecting-against-invalid-hostname-access)
# Running Metabase on AWS Elastic Beanstalk
The Metabase team runs a number of production installations on AWS using Elastic Beanstalk and currently recommend it as the preferred choice for production deployments. Below is a detailed guide to installing Metabase on Elastic Beanstalk.
......@@ -7,7 +16,7 @@ The Metabase team runs a number of production installations on AWS using Elastic
Metabase provides an Elastic Beanstalk pre-configured launch url to help new installations getting started. If you are starting fresh we recommend you follow this link to begin creating the Elastic Beanstalk deployment with a few choices pre-filled.
[Launch Metabase on Elastic Beanstalk](http://downloads.metabase.com/v0.12.0/launch-aws-eb.html)
[Launch Metabase on Elastic Beanstalk](http://downloads.metabase.com/v0.13.0/launch-aws-eb.html)
The rest of this guide will follow each phase of the Elastic Beanstalk setup step-by-step.
......@@ -44,7 +53,7 @@ When your environment type settings look like the above then go ahead and click
The application version describes the exact binary you wish to deploy to your Elastic Beanstalk application. Metabase provides a pre-built AWS Elastic Beanstalk application version which can be linked to directly. Simply enter the following url in the `S3 URL` textbox:
https://s3.amazonaws.com/downloads.metabase.com/v0.12.0/metabase-aws-eb.zip
https://s3.amazonaws.com/downloads.metabase.com/v0.13.0/metabase-aws-eb.zip
Leave all the settings under Deployment Limits on their defaults. These settings won't impact Metabase.
......@@ -177,7 +186,7 @@ Here's each step:
1. Go to Elastic Beanstalk and select your `Metabase` application
* Click on `Application Versions` on the left nav (you can also choose `Application Versions` from the dropdown at the top of the page)
* Download the latest Metabase Elastic Beanstalk deployment file
* https://s3.amazonaws.com/downloads.metabase.com/v0.12.0/aws-elastic-beanstalk.zip
* https://s3.amazonaws.com/downloads.metabase.com/v0.13.0/aws-elastic-beanstalk.zip
* Upload a new Application Version
* Click the `Upload` button on the upper right side of the listing
* Give the new version a name, ideally including the Metabase version number (e.g. v0.13.0)
......@@ -233,14 +242,47 @@ This will create a new certificate inside your AWS environment which can be reus
### Modify Metabase to enforce HTTPS
* Https Support (optional: if you are just doing a trial or don’t have an ssl certificate you can skip this)
* Prerequisites
* Before trying to enable Https support you must **Upload a Server Certificate** to your AWS account
* Click on the box labeled **Load Balancing** under the heading **Network Tier**
* Set the value of **Listener port**: to *OFF*
* Set the value of **Secure listener port**: to *443*
* In the dropdown for **SSL certificate ID**: choose the certificate that you would like to use for this Environment
* NOTE: the certificate MUST match the domain you plan to use for your Metabase install
* Scroll to the bottom of the page and click **Save** in the lower right
* NOTE: your Environment will begin updating with your new change. you will have to wait for this to complete before making additional updates
* IMPORTANT: once this change is made you will no longer be able to access your Metabase instance at the *.elasticbeanstalk.com url provided by Amazon because it will result in a certificate mismatch. To continue accessing your secure Metabase instance you must **Setup DNS CNAME**
Before trying to enable Https support you must upload a server certificate to your AWS account. Instructions above.
1. Go to Elastic Beanstalk and select your `Metabase` application
* Click on Environment that you would like to update
* Click on `Configuration` on the left hand sidebar
* Scroll down to `Load Balancing` under the _Network Tier_ section and click the gear icon to edit those settings.
* Set the value for `Secure listener port` to *443*
* Then, a little bit lower on the dropdown for `SSL certificate ID`, choose the name of the certificate that you uploaded to your account.
* NOTE: the certificate MUST match the domain you plan to use for your Metabase install
* Scroll to the bottom of the page and click `Save` in the lower right
* NOTE: your Environment will begin updating with your new change. you will have to wait for this to complete before making additional updates
* IMPORTANT: once this change is made you will no longer be able to access your Metabase instance at the \*.elasticbeanstalk.com url provided by Amazon because it will result in a certificate mismatch. To continue accessing your secure Metabase instance you must [Setup a DNS CNAME](#setup-dns-cname)
Once your application is working properly over HTTPS we recommend setting an additional property to force non-https clients to use the HTTPS endpoint
1. Click on `Configuration` on the left hand sidebar
* Scroll down to `Software Configuration` under the _Web Tier_ section and click the gear icon to edit those settings.
* Under `Environment Properties` add an entry for `NGINX_FORCE_SSL` with a value of `1`
* Scroll to the bottom of the page and click `Apply` in the lower right, then wait for your application to update.
# Using Papertrail for logging on AWS
This provides a simple way to use the Papertrail logging service for collecting the logs for you Metabase instance in an easy to read location.
1. Click on `Configuration` on the left hand sidebar
* Scroll down to `Software Configuration` under the _Web Tier_ section and click the gear icon to edit those settings.
* Under `Environment Properties` add the following entries
* `PAPERTRAIL_HOST` - provided by Papertrail
* `PAPERTRAIL_PORT` - provided by Papertrail
* `PAPERTRAIL_HOSTNAME` - the name you want to see showing up in Papertrail for this server
* Scroll to the bottom of the page and click `Apply` in the lower right, then wait for your application to update.
*NOTE:* sometimes these settings will not apply until you restart your application server, which you can do by either choosing `Restart App Server(s)` from the Actions dropdown or by deploying the same version again.
# Protecting against invalid hostname access
For the truly paranoid, we provide a setting in the AWS EB deployment which enforces an nginx check of the hostname of the incoming request and terminates the request if the client is not requesting the exact hostname that we expect. This is nice for preventing random internet traffic from stumbling upon your Metabase instance.
1. Click on `Configuration` on the left hand sidebar
* Scroll down to `Software Configuration` under the _Web Tier_ section and click the gear icon to edit those settings.
* Under `Environment Properties` add an entry for `NGINX_SERVER_NAME` with a value corresponding to the exact domain name you are using for your Metabase instance.
* Scroll to the bottom of the page and click `Apply` in the lower right, then wait for your application to update.
......@@ -16,8 +16,7 @@ This will launch a Heroku deployment using a github repository that Metabase mai
### Known Issues
* Sometimes the app boots slowly on Heroku instances and fails to fully start within 60 seconds which results in a failed launch. Just watch out for this and retry if it happens.
* Heroku’s 30 second timeouts on all web requests can cause a few issues if you happen to have longer running database queries. Most people don’t run into this but be aware that it’s possible.
* If you don’t access the application for a while Heroku will sleep your Metabase environment. This won’t harm anything, but it can seem like the application is slow to respond when actually its just Heroku waking up the environment.
* If you don’t access the application for a while Heroku will sleep your Metabase environment. This prevents things like Pulses and Metabase background tasks from running when scheduled and at times makes the app appear to be slow when really it's just Heroku reloading your app.
Now that you’ve installed Metabase, it’s time to [set it up and connect it to your database](../setting-up-metabase.md).
......@@ -47,58 +47,3 @@ You can use another port than 3000 by setting the `MB_JETTY_PORT` environment va
Note that in the default configuration Metabase will use a local H2 database for storing all its own application data. This is meant for simple evaluations or personal use, so if you want to run Metabase for a team we recommend you upgrade to a more robust SQL server such as Postgres. See below for details on how to do that.
Now that you’ve installed Metabase, it’s time to [set it up and connect it to your database](../setting-up-metabase.md).
### The Metabase Application Database
The application database is where Metabase stores information about users, saved questions, dashboards, and any other data needed to run the application. The default settings use an H2 database, but other also Postgres and MySQL are available.
#### [H2](http://www.h2database.com/) (default)
To use the H2 database for your Metabase instance you don't need to do anything at all. When the application is first launched it will attempt to create a new H2 database in the same filesystem location the application is launched from.
You can see these database files from the terminal:
ls metabase.*
You should see the following files:
metabase.db.h2.db
metabase.db.trace.db
If for any reason you want to use an H2 database file in a separate location from where you launch Metabase you can do so using an environment variable. For example:
export MB_DB_TYPE=h2
export MB_DB_FILE=/the/path/to/my/h2.db
java -jar metabase.jar
#### [Postgres](http://www.postgresql.org/)
For production installations of Metabase we recommend that users replace the H2 database with Postgres. This offers a greater degree of performance and reliability when Metabase is running with many users.
You can change the application database to use Postgres using a few simple environment variables. For example:
export MB_DB_TYPE=postgres
export MB_DB_DBNAME=metabase
export MB_DB_PORT=5432
export MB_DB_USER=<username>
export MB_DB_PASS=<password>
export MB_DB_HOST=localhost
java -jar metabase.jar
This will tell Metabase to look for its application database using the supplied Postgres connection information.
#### [MySQL](http://www.mysql.com/)
You can change the application database to use MySQL using a few simple environment variables. For example:
export MB_DB_TYPE=mysql
export MB_DB_DBNAME=metabase
export MB_DB_PORT=3306
export MB_DB_USER=<username>
export MB_DB_PASS=<password>
export MB_DB_HOST=localhost
java -jar metabase.jar
This will tell Metabase to look for its application database using the supplied MySQL connection information.
NOTE: you cannot change the application database while the application is running. these values are read only once when the application starts up and will remain constant throughout the running of the application.
NOTE: currently Metabase does not support migrating data from one application database to another, so if you start with H2 and then want to move to Postgres you'll have to dump the data from H2 and import it into Postgres before relaunching the application.
**This guide will teach you:**
**Covered in this guide:**
> [How to install Metabase](#installing-and-running-metabase)
> [Tips for troubleshooting various issues](#troubleshooting-common-problems)
> [Configuring the application database](#configuring-the-metabase-application-database)
> [Running database migrations manually](#running-metabase-database-migrations-manually)
> [Backing up Metabase Application Data](#backing-up-metabase-application-data)
> [Customizing the Metabase Jetty Webserver](#customizing-the-metabase-jetty-webserver)
> [Changing password complexity](#changing-metabase-password-complexity)
> [How to install Metabase](#installing-metabase)
> [Tips for troubleshooting various issues](#troubleshooting-metabase)
> [Common customizations](#customizing-metabase)
# <a name="installing-metabase"></a>Installing and Running Metabase
# Installing and Running Metabase
Metabase is built and packaged as a Java jar file and can be run anywhere that Java is available. Below we provide detailed instructions on how to install and run Metabase in a variety of common configurations.
......@@ -29,7 +32,7 @@ Step-by-step instructions on how to deploy Metabase on Elastic Beanstalk using R
Currently in beta. We've run Metabase on Heroku and it works just fine, but it's not hardened for production use just yet. If you're up for it then give it a shot and let us know how we can make it better!
# <a name="troubleshooting-metabase"></a>Troubleshooting Common Problems
# Troubleshooting Common Problems
### Metabase fails to startup
......@@ -42,11 +45,154 @@ When this happens, go to a terminal where Metabase is installed and run:
in the command line to manually clear the locks. Then restart your Metabase instance.
# <a name="customizing-metabase"></a>Custom Options
# Configuring the Metabase Application Database
The application database is where Metabase stores information about users, saved questions, dashboards, and any other data needed to run the application. The default settings use an embedded H2 database, but this is configurable.
**NOTE:** you cannot change the application database while the application is running. these values are read only once when the application starts up and will remain constant throughout the running of the application.
**NOTE:** currently Metabase does not provide automated support for migrating data from one application database to another, so if you start with H2 and then want to move to Postgres you'll have to dump the data from H2 and import it into Postgres before relaunching the application.
#### [H2](http://www.h2database.com/) (default)
To use the H2 database for your Metabase instance you don't need to do anything at all. When the application is first launched it will attempt to create a new H2 database in the same filesystem location the application is launched from.
You can see these database files from the terminal:
ls metabase.*
You should see the following files:
metabase.db.h2.db
metabase.db.trace.db
If for any reason you want to use an H2 database file in a separate location from where you launch Metabase you can do so using an environment variable. For example:
export MB_DB_TYPE=h2
export MB_DB_FILE=/the/path/to/my/h2.db
java -jar metabase.jar
#### [Postgres](http://www.postgresql.org/)
For production installations of Metabase we recommend that users replace the H2 database with a more robust option such as Postgres. This offers a greater degree of performance and reliability when Metabase is running with many users.
You can change the application database to use Postgres using a few simple environment variables. For example:
export MB_DB_TYPE=postgres
export MB_DB_DBNAME=metabase
export MB_DB_PORT=5432
export MB_DB_USER=<username>
export MB_DB_PASS=<password>
export MB_DB_HOST=localhost
java -jar metabase.jar
This will tell Metabase to look for its application database using the supplied Postgres connection information.
#### [MySQL](http://www.mysql.com/)
If you prefer to use MySQL we've got you covered. You can change the application database to use MySQL using these environment variables. For example:
export MB_DB_TYPE=mysql
export MB_DB_DBNAME=metabase
export MB_DB_PORT=3306
export MB_DB_USER=<username>
export MB_DB_PASS=<password>
export MB_DB_HOST=localhost
java -jar metabase.jar
This will tell Metabase to look for its application database using the supplied MySQL connection information.
# Running Metabase database migrations manually
When Metabase is starting up it will typically attempt to determine if any changes are required to the application database and it will execute those changes automatically. If for some reason you wanted to see what these changes are and run them manually on your database then we let you do that.
Simply set the following environment variable before launching Metabase:
export MB_DB_AUTOMIGRATE=false
When the application launches, if there are necessary database changes, you'll receive a message like the following which will indicate that the application cannot continue starting up until the specified upgrades are made:
2015-12-01 12:45:45,805 [INFO ] metabase.db :: Database Upgrade Required
NOTICE: Your database requires updates to work with this version of Metabase. Please execute the following sql commands on your database before proceeding.
-- *********************************************************************
-- Update Database Script
-- *********************************************************************
-- Change Log: migrations/liquibase.json
-- Ran at: 12/1/15 12:45 PM
-- Against: @jdbc:h2:file:/Users/agilliland/workspace/metabase/metabase/metabase.db
-- Liquibase version: 3.4.1
-- *********************************************************************
-- Create Database Lock Table
CREATE TABLE PUBLIC.DATABASECHANGELOGLOCK (ID INT NOT NULL, LOCKED BOOLEAN NOT NULL, LOCKGRANTED TIMESTAMP, LOCKEDBY VARCHAR(255), CONSTRAINT PK_DATABASECHANGELOGLOCK PRIMARY KEY (ID));
...
Once your database is updated try running the application again.
2015-12-01 12:46:39,489 [INFO ] metabase.core :: Metabase Shutting Down ...
You can then take the supplied SQL script and apply it to your database manually. Once that's done just restart Metabase and everything should work normally.
# Backing up Metabase Application Data
If you are using Metabase in a production environment or simply want to make sure you don't lose any of the work that you've done, then backups are what you need.
Metabase uses a single SQL database for all of its runtime application data, so all you need to do is backup that database and you're good to go. From a database back-up you can restore any Metabase installation.
### H2 Embedded Database (default)
If you launched Metabase on a laptop or PC the application will create an embedded H2 database in the directory it is being run in. Navigate to the directory where you started Metabase from and find the file named `metabase.db.h2.db`. Simply copy that file somewhere safe and you are all backed up!
NOTE: If your Metabase is currently running it's best to shut down the Metabase process before making a backup copy of the file. Then, restart the application.
### Amazon RDS for the Database Application
Amazon has its own best practices on how to backup and restore RDS databases, so we'll defer to them. We recommend that you enable automated RDS Backups.
Instructions can be found in the [Amazon RDS User Guide](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html).
### Self-managed PostgreSQL or MySQL database
Simply follow the same instructions you would use for making any normal database backup. It's a large topic more fit for a DBA to answer, but as long as you have a dump of the Metabase database you'll be good to go.
# Customizing the Metabase Jetty webserver
In most cases there will be no reason to modify any of the settings around how Metabase runs its embedded Jetty webserver to host the application, but if you wish to run HTTPS directly with your Metabase server or if you need to run on another port, that's all configurable.
### Running Metabase on another port
By default Metabase will launch on port 3000, but if you prefer to run the application on another port you can do so by setting the following environment variable:
export MB_JETTY_PORT=12345
java -jar metabase.jar
In this example once the application starts up you will access it on port `12345` instead of the default port of 3000.
### Using HTTPS with Metabase
If you have an ssl certificate and would prefer to have Metabase run over HTTPS directly using its webserver you can do so by using the following environment variables:
export MB_JETTY_SSL="true"
export MB_JETTY_SSL_Port="8443"
export MB_JETTY_SSL_Keystore="path/to/keystore.jks"
export MB_JETTY_SSL_Keystore_Password="storepass"
java -jar metabase.jar
With the above settings applied you will be running Metabase on port 8443 over HTTPS using the supplied certificate. #secured
# Changing Metabase password complexity
Metabase offers a couple controls for administrators who prefer to increase the password requirements on their user accounts.
#### HTTPS Support
export MB_PASSWORD_COMPLEXITY=strong
export MB_PASSWORD_LENGTH=10
Regardless of how you deploy Metabase, it is *strongly* recommended that you use HTTPS for all traffic. If you are using Elastic Beanstalk or AWS, we recommend you use ELB and terminate the HTTPS connection there. Otherwise, you can use nginx as a reverse proxy and terminate there.
The settings above can be used independently, so it's fine to use only one or the other. By default Metabase use complexity = `normal` and a password length of 6. The following options are available for complexity choice:
#### [Backing up your Metabase](backing-up-the-metabase-database.md)
Better safe than sorry we always say. Simple instructions to help with backing up a Metabase instance.
* `weak` = no character constraints
* `normal` = at least 1 digit
* `strong` = minimum 8 characters w/ 2 lowercase, 2 uppercase, 1 digit, and 1 special character
......@@ -42,7 +42,14 @@ One last quick thing that you’ll have to decide is if it’s okay for us to co
![Usage data preferences](images/UsageData.png)
If you’re ready to start using Metabase, go ahead and click **Next** and then **Take me to Metabase**.
If you’re ready to start using Metabase, go ahead and click **Next**
## Staying in touch
At this point you are all set and ready to use Metabase. Since we like keeping in touch with our friends we made it easy to sign up for our newsletter (infrequent emails) with a single click!
![Metabase Newsletter](images/NewsletterSignup.png)
Once you're done here simply follow the link to **Take me to Metabase**. And if you decided to skip the newsletter sign-up it's cool, we still like you :)
# Next: Getting started with Metabase
For a quick overview of how to use Metabase, head over to the [Getting Started Guide](getting-started.md).
......
......@@ -10,5 +10,5 @@ Some tips:
---
## Next: data model references
Sometimes you’ll need help understanding what data is available to you and what it means. Metabase provides a way for your administrators and data experts to build a [data model reference](07-data-model-reference.md) to help you make sense of your database.
\ No newline at end of file
## Next: sharing data with Pulses
Beyond dashboards, another great way to share updates on important metrics is with the [Pulses feature](07-pulses.md).
\ No newline at end of file
## Sharing Updates with Pulses
The Pulses feature in Metabase gives you the ability to automatically send regular updates to your teammates to help everyone keep track of changes to the metrics that matter to you most. You can deliver a pulse via email or [Slack](https://slack.com/), on the schedule of your choice.
You can create a pulse and view all of the existing pulses by clicking the `Pulses` link from the top menu. Click `Create a pulse` to get started.
![Create a pulse](images/pulses/01-empty-state.png)
### Name It
First, choose a name for your pulse. This will show up in the email subject line and the Slack message title, so choose something that will let people know what kind of updates the pulse will contain, like “Daily Marketing Update,” or “Users Metrics.”
![Giving it a name](images/pulses/02-name-it.png)
### Pick Your Data
Before you can create a pulse, you’ll need to have some [saved questions](05-sharing-answers.md). You can choose up to five of them to put into a single pulse. Click the dropdown to see a list of all your saved questions. You can type in the dropdown to help filter and find the question you’re looking for.
![Pick your data](images/pulses/03-pick-your-data.png)
When you select a saved question, Metabase will show you a preview of how it’ll look in the pulse. Because of the space constraints of email and Slack, Metabase will automatically make some adjustments to the appearance of your saved question so that it looks great in the pulse. For example, in order to save space, pie charts will automatically be transformed into bar charts.
![Behold! The metamorphosis.](images/pulses/04-transformation.png)
Currently, there are a few restrictions on what kinds of saved questions you can put into a pulse:
* Raw data can’t be put in a pulse
* Tables will be cropped to a maximum of three columns and 10 rows
* Bar charts (and pie charts which get turned into bar charts) will be cropped to one column for the labels, one column for the values, and 10 total rows
### Choose How and When to Deliver Your Data
Each pulse you create can be delivered by email, Slack, or both. You can also set a different delivery schedule for email versus Slack. To deliver by email, just type in the email addresses you want to send the pulse to, separated by commas. Then, choose to either send it daily or weekly, and the time you want it to be sent.
![Setting the email schedule](images/pulses/05-email-schedule.png)
To send via Slack, you’ll need to choose which channel you want to post the pulse in, whether you want it to post hourly or daily, and at what time. Again, the schedule for Slack can be different from the schedule for email.
Once you’re done, just click `Create pulse`. You’ll see your new pulse, along with its recipients, and the saved questions that are included in the pulse. If anyone else on your team wants to subscribe to a pulse that’s delivered by email, they can click the button that says `Get this email` from the Pulses screen.
![A beautiful, completed pulse](images/pulses/06-created.png)
### Editing and Deleting a Pulse
If you ever need to make changes to a pulse, just hover over the pulse from the list and click the `edit` button that appears.
![Edit button](images/pulses/07-edit-button.png)
If you want to delete a pulse, you can find that option at the bottom of the edit screen. Just remember: if you delete a pulse, no one will receive it anymore.
![The danger zone](images/pulses/08-delete.png)
---
## Next: data model references
Sometimes you’ll need help understanding what data is available to you and what it means. Metabase provides a way for your administrators and data experts to build a [data model reference](08-data-model-reference.md) to help you make sense of your database.
\ No newline at end of file
docs/users-guide/images/pulses/01-empty-state.png

175 KiB

docs/users-guide/images/pulses/02-name-it.png

155 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment