Skip to content
Snippets Groups Projects
README.md 4.2 KiB
Newer Older
  • Learn to ignore specific revisions
  • Kyle Doherty's avatar
    Kyle Doherty committed
    # Metabase
    
    [Metabase](https://www.metabase.com) is the easy, open-source way for everyone in your company to ask questions and learn from data.
    
    Kyle Doherty's avatar
    Kyle Doherty committed
    
    
    ![Metabase Product Screenshot](docs/images/metabase-product-screenshot.svg)
    
    [![Latest Release](https://img.shields.io/github/release/metabase/metabase.svg?label=latest%20release)](https://github.com/metabase/metabase/releases)
    
    Allen Gilliland's avatar
    Allen Gilliland committed
    [![Circle CI](https://circleci.com/gh/metabase/metabase.svg?style=svg&circle-token=3ccf0aa841028af027f2ac9e8df17ce603e90ef9)](https://circleci.com/gh/metabase/metabase)
    
    [![codecov](https://codecov.io/gh/metabase/metabase/branch/master/graph/badge.svg)](https://codecov.io/gh/metabase/metabase)
    
    ![Docker Pulls](https://img.shields.io/docker/pulls/metabase/metabase)
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    ## Features
    
    - [Set up in five minutes](https://www.metabase.com/docs/latest/setting-up-metabase.html) (we're not kidding).
    - Let anyone on your team [ask questions](https://www.metabase.com/docs/latest/users-guide/04-asking-questions.html) without knowing SQL.
    
    - Use the [SQL editor](https://www.metabase.com/docs/latest/users-guide/writing-sql.html) for more complex queries.
    
    - Build handsome, interactive [dashboards](https://www.metabase.com/docs/latest/users-guide/07-dashboards.html) with filters, auto-refresh, fullscreen, and custom click behavior.
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    - Create [models](https://www.metabase.com/learn/getting-started/models) that clean up, annotate, and/or combine raw tables.
    
    - Define canonical [segments and metrics](https://www.metabase.com/docs/latest/administration-guide/07-segments-and-metrics.html) for your team to use.
    - Send data to Slack or email on a schedule with [dashboard subscriptions](https://www.metabase.com/docs/latest/users-guide/dashboard-subscriptions).
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    - Set up [alerts](https://www.metabase.com/docs/latest/users-guide/15-alerts.html) to have Metabase notify you when your data changes.
    - [Embed charts and dashboards](https://www.metabase.com/docs/latest/administration-guide/13-embedding.html) in your app, or even [your entire Metabase](https://www.metabase.com/docs/latest/enterprise-guide/full-app-embedding.html).
    
    Allen Gilliland's avatar
    Allen Gilliland committed
    
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    Take a [tour of Metabase](https://www.metabase.com/learn/getting-started/tour-of-metabase).
    
    Allen Gilliland's avatar
    Allen Gilliland committed
    
    
    Kyle Doherty's avatar
    Kyle Doherty committed
    ## Supported databases
    
    Allen Gilliland's avatar
    Allen Gilliland committed
    
    
    - [Officially supported databases](./docs/databases/connecting.md#connecting-to-supported-databases)
    - [Partner and Community drivers](./docs/developers-guide/partner-and-community-drivers.md)
    
    Allen Gilliland's avatar
    Allen Gilliland committed
    
    
    Kyle Doherty's avatar
    Kyle Doherty committed
    ## Installation
    
    Allen Gilliland's avatar
    Allen Gilliland committed
    
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    Metabase can be run just about anywhere. Check out our [Installation Guides](https://www.metabase.com/docs/latest/operations-guide/installing-metabase.html).
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    ## Contributing
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    To get started with a development installation of the Metabase, check out our [Developers Guide](https://www.metabase.com/docs/latest/developers-guide/start).
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    ## Internationalization
    
    We want Metabase to be available in as many languages as possible. See which translations are available and help contribute to internationalization using our project over at [POEditor](https://poeditor.com/join/project/ynjQmwSsGh). You can also check out our [policies on translations](https://www.metabase.com/docs/latest/administration-guide/localization.html).
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    ## Extending Metabase
    
    Hit our Query API from Javascript to integrate analytics. Metabase enables your application to:
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    - Build moderation interfaces.
    - Export subsets of your users to third party marketing automation software.
    
    - Provide a custom customer lookup application for the people in your company.
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    Check out our guide, [Working with the Metabase API](https://www.metabase.com/learn/administration/metabase-api).
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    ## Security Disclosure
    
    Kyle Doherty's avatar
    Kyle Doherty committed
    
    
    Reza Lotun's avatar
    Reza Lotun committed
    See [SECURITY.md](./SECURITY.md) for details.
    
    Kyle Doherty's avatar
    Kyle Doherty committed
    
    
    Jeff Bruemmer's avatar
    Jeff Bruemmer committed
    ## License
    
    This repository contains the source code for both the Open Source edition of Metabase, released under the AGPL, as well as the [commercial editions of Metabase](https://www.metabase.com/pricing), which are released under the Metabase Commercial Software License.
    
    Allen Gilliland's avatar
    Allen Gilliland committed
    
    
    See [LICENSE.txt](./LICENSE.txt) for details.
    
    Allen Gilliland's avatar
    Allen Gilliland committed
    
    
    Unless otherwise noted, all files © 2023 Metabase, Inc.
    
    
    ## [Metabase Experts](https://www.metabase.com/partners/)
    
    
    If you’d like more technical resources to set up your data stack with Metabase, connect with a [Metabase Expert](https://www.metabase.com/partners/?utm_source=readme&utm_medium=metabase-expetrs&utm_campaign=readme).