Skip to content
Snippets Groups Projects
Unverified Commit 63d72010 authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

remove tables of contents (#25466)

parent 450c308a
No related branches found
No related tags found
No related merge requests found
Showing
with 20 additions and 143 deletions
......@@ -8,12 +8,6 @@ redirect_from:
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.
- [Configuring your email account](#configuring-your-email-account)
- [Google Apps](#google-apps)
- [Amazon SES](#amazon-ses)
- [Mandrill](#mandrill)
- [Recommended settings](#recommended-settings)
## Configuring your email account
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.
......
......@@ -8,14 +8,6 @@ redirect_from:
If you want to have your [Dashboard subscriptions][dashboard-subscriptions] sent to Slack channels (or people on Slack), an admin must first integrate your Metabase with Slack.
Here's an overview of the steps for setting up Slack:
1. [Create your Slack App](#create-your-slack-app)
2. [Install your app to your workspace](#install-your-app-to-your-workspace)
3. [Get the Bot User OAuth Token](#the-bot-user-oauth-token)
4. [Create a dedicated Metabase channel in your Slack](#create-a-dedicated-metabase-channel-in-your-slack)
5. [Save your changes](#save-your-changes-in-metabase)
## Create your Slack App
For Metabase to post to your Slack channels, you’ll need to create a Slack App and make it available to Metabase.
......
......@@ -6,13 +6,7 @@ redirect_from:
# Adding and managing databases
- [Adding a database connection](#adding-a-database-connection)
- [Connecting to supported databases](#connecting-to-supported-databases)
- [Connecting to databases hosted by a cloud provider](#connecting-to-databases-hosted-by-a-cloud-provider)
- [Database connection options](#database-connection-options)
- [Syncing and scanning databases](#syncing-and-scanning-databases)
- [Deleting databases](#deleting-databases)
- [Troubleshooting](#troubleshooting)
Connect Metabase to your data sources.
## Adding a database connection
......
......@@ -8,14 +8,6 @@ redirect_from:
Metabase stores connection information for the various databases you add in the [Metabase application database](https://www.metabase.com/glossary/application_database). To prevent bad actors from being able to access these details if they were to gain access to the application DB, Metabase can automatically encrypt them with AES256 + SHA512 when they are saved, and decrypt them on-the-fly whenever they are needed.
- [Creating an encryption key](#creating-an-encryption-key)
- [Example commands for creating and adding a key](#example-commands-for-creating-and-adding-a-key)
- [Encrypting an existing connection](#encrypting-an-existing-connection)
- [Rotating an encryption key](#rotating-an-encryption-key)
- [Example command for rotating a key](#example-command-for-rotating-a-key)
- [Disabling an encryption key](#disabling-an-encryption-key)
- [Example command for disabling a key](#example-command-for-disabling-a-key)
## Creating an encryption key
1. Generate a secret key that is at least 16 characters (longer is even better!). We recommend using a secure random key generator, such as `openssl`.
......
......@@ -8,11 +8,6 @@ redirect_from:
Metabase can connect to some databases by first establishing a connection to a server in between Metabase and a data warehouse, then connecting to the data warehouse using that connection as a bridge. This makes connecting to some data warehouses possible in situations that would otherwise prevent the use of Metabase.
- [When to use SSH tunneling](#when-to-use-ssh-tunneling)
- [How to use SSH tunneling](#how-to-use-ssh-tunneling)
- [Disadvantages of indirect connections](#disadvantages-of-indirect-connections)
- [Running SSH directly](#running-ssh-directly)
## When to use SSH tunneling
In general, there are two basic use cases for an SSH tunnel:
......
......@@ -8,21 +8,6 @@ redirect_from:
This guide covers the basics for running your Metabase instance in Microsoft Azure using Docker.
- [Running Metabase on Microsoft Azure](#running-metabase-on-microsoft-azure)
- [Step 1: Create the resource group (resource grouping)](#step-1-create-the-resource-group-resource-grouping)
- [Step 2: Create the VNET (virtual network)](#step-2-create-the-vnet-virtual-network)
- [Step 3: Create the Application Database (PostgreSQL)](#step-3-create-the-application-database-postgresql)
- [Step 4: Create the private endpoint connection](#step-4-create-the-private-endpoint-connection)
- [Step 5: Create web application (deploy Metabase)](#step-5-create-web-application-deploy-metabase)
- [Additional configurations](#additional-configurations)
- [How to enable Health checks](#how-to-enable-health-checks)
- [How to upgrade](#how-to-upgrade)
- [How to see the logs](#how-to-see-the-logs)
- [Performance tuning](#performance-tuning)
- [Custom domains](#custom-domains)
- [Scale-up vs Scale-out](#scale-up-vs-scale-out) - [CORS](#cors)
- [Database name](#database-name)
## Step 1: Create the resource group (resource grouping)
On the Azure management console, click on the **Resource Groups** icon at the top of the page (or just search for Resource Groups). If you already have a resource group, you can go straight to [Step 2](#step-2-create-the-vnet-virtual-network).
......@@ -206,4 +191,4 @@ In the example above the connection string would be
```
postgresql://10.0.2.4:5432/metabase?user=metabase@metabase-app-database&password=Password1!&ssl=true&sslmode=require
```
\ No newline at end of file
```
......@@ -10,12 +10,6 @@ Metabase provides an official Docker image via Dockerhub that can be used for de
If you're trying to upgrade your Metabase version on Docker, check out these [upgrading instructions](upgrading-metabase.md).
- [Open Source quick start](#open-source-quick-start)
- [Pro or Enterprise quick start](#pro-or-enterprise-quick-start)
- [Production installation](#production-installation)
- [Migrating to a production installation](#migrating-to-a-production-installation)
- [Additional Docker maintenance and configuration](#additional-docker-maintenance-and-configuration)
## Open Source quick start
Use this quick start to run the Open Source version of Metabase locally. See below for instructions on [running Metabase in production](#production-installation).
......
......@@ -8,10 +8,6 @@ redirect_from:
To run the free, Open Source version of Metabase via a JAR file, you will need to have a Java Runtime Environment (JRE) installed on your system.
- [Quick start](#quick-start)
- [Local installation](#local-installation)
- [Production installation](#production-installation)
If you have a token for the [Pro or Enterprise editions](https://www.metabase.com/pricing/) of Metabase, see [Activating your Metabase commercial license](../paid-features/activating-the-enterprise-edition.md).
## Quick start
......
......@@ -6,11 +6,7 @@ redirect_from:
# Account settings
You can view your account settings by going to the top right of the screen and clicking on the **gear** icon > **Account settings**. Here you'll find three tabs:
- [Profile](#account-profile)
- [Password](#account-password)
- [Login history](#account-login-history)
You can view your account settings by going to the top right of the screen and clicking on the **gear** icon > **Account settings**.
## Account profile
......@@ -33,4 +29,4 @@ Whenever you log in from a new device, Metabase will send you an email just to l
## Disable animations in Metabase
This isn't an in-Metabase setting, but just so you know: you can disable UI animations in Metabase (like sidebars sliding around, or rotating spinners) by changing the settings for your operating system so it respects the `prefers-reduced-motion` CSS media feature. This change will also affect other applications, not just Metabase. Check out the instructions for how to set the user preferences for your operating system in the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion#user_preferences).
\ No newline at end of file
This isn't an in-Metabase setting, but just so you know: you can disable UI animations in Metabase (like sidebars sliding around, or rotating spinners) by changing the settings for your operating system so it respects the `prefers-reduced-motion` CSS media feature. This change will also affect other applications, not just Metabase. Check out the instructions for how to set the user preferences for your operating system in the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion#user_preferences).
......@@ -8,10 +8,6 @@ redirect_from:
{% include plans-blockquote.html feature="SAML authentication" %}
- [Enable SAML in Metabase](#enable-saml-in-metabase)
- [Add an Enterprise Application in Azure AD](#add-an-enterprise-application-in-azure-ad)
- [Configure the Enterprise Application with Metabase SSO information](#configure-the-enterprise-application-with-metabase-sso-information)
## Enable SAML in Metabase
First, follow our guide to [enable SAML authentication](authenticating-with-saml.md).
......
......@@ -6,13 +6,6 @@ title: SAML with Okta
{% include plans-blockquote.html feature="Okta SAML authentication" %}
1. [Creating an app integration in Okta][okta-saml-docs] (the identity provider).
2. [Configuring SAML settings in Okta](#configuring-saml-settings-in-okta).
3. [Managing signing certificates in Okta](#managing-signing-certificates-in-okta).
4. [Configuring group mappings](#configuring-group-mappings) (optional).
For more information, check out our guide for [authenticating with SAML][saml-doc].
## Configuring SAML settings in Okta
| Metabase SAML | Okta SAML |
......
......@@ -12,10 +12,6 @@ Application settings are useful for granting groups access to some, but not all,
To set application permissions, got to the top right of the screen and click on the **gear** icon > **Admin settings** > **Permissions** > **Application**.
- [Settings access](#settings-access)
- [Monitoring access](#monitoring-access)
- [Subscriptions and alerts](#subscriptions-and-alerts)
## Settings access
Settings access defines which groups can view and edit the settings under the Admin > Settings tab. These settings include:
......
......@@ -6,11 +6,6 @@ title: Troubleshooting database connections
If you can't connect to your database, you'll need to figure out if the problem is happening with Metabase or your database server.
- [Troubleshooting connections to Metabase](#troubleshooting-connections-to-metabase).
- [Troubleshooting connections to the database server](#troubleshooting-connections-to-the-database-server).
- [Common database connection errors](#common-database-connection-errors).
- [Testing a database connection](#testing-a-database-connection).
If your database connection is successful, but the tables aren't showing up in the [Data Browser](https://www.metabase.com/learn/getting-started/data-browser), go to [Troubleshooting missing tables](./cant-see-tables.md).
## Troubleshooting connections to Metabase
......
......@@ -4,16 +4,6 @@ title: Running Metabase on Docker
# Running Metabase on Docker
<div class='doc-toc' markdown=1>
- [Metabase container exits without starting the server](#container-exits-without-starting-server)
- [Metabase container is running but the server is not](#container-running-but-server-is-not)
- [Not connecting to a remote application database](#not-connecting-to-remote-app-db)
- [The Metabase server isn't able to connect to a MySQL or PostgreSQL database](#metabase-cant-connect-to-mysql-or-postgresql)
- [The Metabase application database is not being persisted](#app-db-not-being-persisted)
- [The internal port isn't being remapped correctly](#internal-port-not-remapped-correctly)
- [Metabase can't write or read to/from a file or directory](#cant-write-read-file-or-dir)
</div>
Docker simplifies many aspects of running Metabase, but there are some pitfalls to keep in mind. If you have trouble with Metabase under Docker, try going through the troubleshooting process below, then look below for details about the specific issue you've found.
1. Is the container running?
......@@ -35,7 +25,7 @@ And to get the logs for the Metabase container:
docker logs -f CONTAINER_NAME
```
<h2 id="container-exits-without-starting-server">Metabase container exits without starting the server</h2>
## Metabase container exits without starting the server
**How to detect this:** Run `docker ps` to see if the Metabase container is currently running. If it is, move on to the next step.
......@@ -51,7 +41,7 @@ Look for the container that exited most recently and make a note of the containe
Docker logs CONTAINER_ID
```
<h2 id="container-running-but-server-is-not">Metabase container is running but the server is not</h2>
## Metabase container is running but the server is not
**How to detect this:** Run `docker ps` to make sure the container is running. The server should be logging to the Docker container logs. Check this by running:
......@@ -92,7 +82,7 @@ If the container is being terminated before it finished starting, the problem co
If the container is _not_ being terminated from the outside, but is failing to start anyway, this problem is probably not specific to Docker. If you're using a Metabase-supplied image, please [open a GitHub issue](https://github.com/metabase/metabase/issues/new/choose).
<h2 id="not-connecting-to-remote-app-db">Not connecting to a remote application database</h2>
## Not connecting to a remote application database
**How to detect this:** If this is a new Metabase instance, then the database you specified via the environment variables will be empty. If this is an existing Metabase instance with incorrect environment parameters, the server will create a new H2 embedded database to use for application data and you’ll see lines similar to these in the log:
......@@ -109,7 +99,7 @@ If the container is _not_ being terminated from the outside, but is failing to s
docker inspect some-postgres -f '{% raw %}{{ .Config.Env }}{% endraw %}'
```
<h2 id="metabase-cant-connect-to-mysql-or-postgresql">The Metabase server isn't able to connect to a MySQL or PostgreSQL database</h2>
## The Metabase server isn't able to connect to a MySQL or PostgreSQL database
**How to detect this:** The logs for the Docker container return an error message after the "Verifying Database Connection" line.
......@@ -135,13 +125,13 @@ nc -v your-db-host 5432
These steps will help you determine whether this the problem is with the network or with authentication.
<h2 id="app-db-not-being-persisted">The Metabase application database is not being persisted</h2>
## The Metabase application database is not being persisted
**How to detect this:** This is occurring if you are getting the Setup screen every time you start the application. The most common cause is not giving the Docker container a persistent filesystem mount to put the application database in.
**How to fix this:** Make sure you are giving the container a [persistent volume][persistent-volume].
<h2 id="internal-port-not-remapped-correctly">The internal port isn't being remapped correctly</h2>
## The internal port isn't being remapped correctly
**How to detect this:** Run `docker ps` and look at the port mapping, then run `curl http://localhost:port-number-here/api/health`. This should return a JSON response that looks like:
......@@ -151,7 +141,7 @@ These steps will help you determine whether this the problem is with the network
**How to fix this:** Make sure to include `-p 3000:3000` or similar port remapping in the `docker run` command you use to start the Metabase container image.
<h2 id="cant-write-read-file-or-dir">Metabase can't write or read to/from a file or directory</h2>
## Metabase can't write or read to/from a file or directory
**How to detect this:** A message in the logs will clearly indicate an IOError or "Permission denied" from Java, or errors from SQLite containing `org.sqlite.core.NativeDB._open_utf8`.
......
......@@ -4,10 +4,6 @@ title: Troubleshooting error messages
# Troubleshooting error messages
- [API error messages][api-error-message]
- [SQL error messages][sql-error-message]
- [Metabase error messages][metabase-error-message]
## [API error messages][discourse-search-api-error]
- Appear in red text when you load a dashboard or run a question.
......
......@@ -6,9 +6,6 @@ title: How to find a known bug or limitation
If you can't find or solve your problem using the [troubleshooting guides](./index.md), you may be running into an issue that we're still working on.
- [How to find a known bug](#how-to-find-a-known-bug)
- [How to find a known product limitation](#how-to-find-a-known-product-limitation)
## How to find a known bug
If your work in Metabase is crashing, missing, or not being saved, you might have found a bug.
......
......@@ -4,16 +4,9 @@ title: LDAP
# LDAP
<div class='doc-toc' markdown=1>
- [LDAP documentation][ldap-docs]
- [LDAP sample configuration](#ldap-sample-configuration)
- [Related software for troubleshooting](#related-software-for-troubleshooting)
- [Current limitations](#current-limitations)
</div>
Metabase can use LDAP for authentication. [This article][ldap-learn] explains how to set it up, and the guide below will help you troubleshoot if anything goes wrong. If your problem isn't specific to LDAP, go to [our troubleshooting guide for logging in](./cant-log-in.md).
<h2 id="ldap-sample-configuration">LDAP sample configuration</h2>
## LDAP sample configuration
You can test Metabase with LDAP by using this `docker-compose` definition:
......@@ -74,7 +67,7 @@ If you don't pass environment variables to Metabase and you want to configure th
For the `USER FILTER`, you can leave the default value, which will look for the user ID in both the `uid` or `email` field.
<h2 id="related-software-for-troubleshooting">Related software for troubleshooting</h2>
## Related software for troubleshooting
If you run into an issue, check that you can login to your LDAP directory and issue queries using software like [Apache Directory Studio][apache-directory-studio]. It will let you see the whole LDAP tree and view the logs of your LDAP application to see queries run.
......
......@@ -6,11 +6,6 @@ title: Troubleshooting models
What kind of problem are you having with your [model][model-docs]?
- [Can't create a model](#cant-create-a-model).
- [Can't edit or save changes to a model](#cant-edit-or-save-changes-to-a-model).
- [Model performance is poor](#model-performance-is-poor).
- [Model doesn't work with data sandboxing][troubleshooting-sandboxing].
## Can't create a model
If you don't see [the model button][model-button-image] (three squares):
......
......@@ -4,11 +4,6 @@ title: Can't save questions or dashboards, or getting a blank page
# Can't save questions or dashboards, or getting a blank page
<div class='doc-toc' markdown=1>
- [Saving questions or dashboards fails](#saving-questions-or-dashboards-fails)
- [Seeing a blank page instead of the Metabase interface](#seeing-blank-page)
</div>
If attempting to save a question or dashboard sometimes fails, or Metabase only loads a blank page, the problem might be the use of a proxy. A proxy could include other functions like a web application firewall (WAF), content optimization, or cache. Examples of proxies that are known to cause issues with Metabase include:
- Cloudflare's Rocket Loader and WAF
......@@ -16,7 +11,7 @@ If attempting to save a question or dashboard sometimes fails, or Metabase only
- PageSpeed module for Apache
- Some anti-virus browser extensions or add-ons
<h2 id="saving-questions-or-dashboards-fails">Saving questions or dashboards fails</h2>
## Saving questions or dashboards fails
If saving questions or dashboards fails and the save button displays "Save Failed," or if you get the error, "Sorry you do not have permission to see that," the problem might be with a WAF like Cloudflare or Azure.
......@@ -29,11 +24,11 @@ Some WAFs have dynamic protection, which means that the problem might only occur
The solution is to disable the WAF for Metabase. Some services will show which rules were triggered, so it might be enough to disable those rules.
<h2 id="seeing-blank-page">Seeing a blank page instead of the Metabase interface</h2>
## Seeing a blank page instead of the Metabase interface
If Metabase displays a blank page instead of its interface, the problem is usually with content optimization like PageSpeed or Cloudflare's Rocket Loader.
- Check the Console tab of your browser's Developer Tools for any errors involving Content Security Policy (CSP).
- See if Metabase has been able to deliver the HTML code by right clicking on the blank page and selecting "View page source." It might look like gibberish, but it should say `<title>Metabase</title>` near line 25.
The solution is to disable content optimization for Metabase.
\ No newline at end of file
The solution is to disable content optimization for Metabase.
......@@ -4,16 +4,9 @@ title: Running Metabase
# Running Metabase
<div class='doc-toc' markdown=1>
- [WARNING: sun.reflect.Reflection.getCallerClass is not supported](#warning-sunreflectreflectiongetcallerclass-is-not-supported)
- [Metabase fails to start due to Heap Space OutOfMemoryErrors](#heap-space-outofmemoryerrors)
- [Diagnosing memory issues causing OutOfMemoryErrors](#diagnosing-outofmemoryerrors)
- [Metabase cannot read or write from a file or folder (IOError)](#cannot-read-write-ioerror)
</div>
Metabase runs on the Java Virtual Machine (JVM), and depending on how it's configured, it may use the server's filesystem to store some information. Problems with either the JVM or the filesystem can therefore prevent Metabase from running.
<h2 id="warning-sunreflectreflectiongetcallerclass-is-not-supported">WARNING: sun.reflect.Reflection.getCallerClass is not supported.</h2>
## WARNING: sun.reflect.Reflection.getCallerClass is not supported
Don't worry about it.
......@@ -23,7 +16,7 @@ WARNING: sun.reflect.Reflection.getCallerClass is not supported. This will impac
If you see the above error, ignore it. Your Metabase is perfectly healthy and performing as it should.
<h2 id="heap-space-outofmemoryerrors">Metabase fails to start due to Heap Space OutOfMemoryErrors</h2>
## Metabase fails to start due to Heap Space OutOfMemoryErrors
The JVM can normally figure out how much RAM is available on the system and automatically set a sensible upper bound for heap memory usage. On certain shared hosting environments, however, this doesn't always work as desired. The usual symptom of this is an error message like:
......@@ -45,7 +38,7 @@ You can also use the environment variable `JAVA_OPTS` to set JVM args instead of
docker run -d -p 3000:3000 -e "JAVA_OPTS=-Xmx2g" metabase/metabase
```
<h2 id="diagnosing-outofmemoryerrors">Diagnosing memory issues causing OutOfMemoryErrors</h2>
## Diagnosing memory issues causing OutOfMemoryErrors
If the Metabase instance starts and runs for a significant amount of time before running out of memory, there might be a specific event, such as a large query, triggering the `OutOfMemoryError`. One way to diagnose where the memory is being used is to enable heap dumps when an `OutOfMemoryError` is triggered. To enable this, you need to add two flags to the `java` invocation:
......@@ -55,7 +48,7 @@ java -Xmx2g -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/path/to/a/director
The `-XX:HeapDumpPath` flag specifies where to put the dump---the current directory is the default. When an `OutOfMemoryError` occurs, it will dump an `hprof` file to the directory specified. These can be very large (i.e., the size of the `-Xmx` argument) so ensure your disk has enough space. These `hprof` files can be read with many different tools, such as `jhat` (which is included with the JDK) or the [Eclipse Memory Analyzer Tool][eclipse-memory-analyzer].
<h2 id="cannot-read-write-ioerror">Metabase cannot read or write from a file or folder (IOError)</h2>
## Metabase cannot read or write from a file or folder (IOError)
If you see an error regarding file permissions, like Metabase being unable to read a SQLite database or a custom GeoJSON map file, check out the section "Metabase can't read to/from a file or directory" in our [Docker troubleshooting guide](./docker.md).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment