redash/README.md

49 lines
3.2 KiB
Markdown
Raw Normal View History

2014-09-17 13:04:30 +00:00
<p align="center">
2017-01-22 21:08:16 +00:00
<img title="Redash" src='https://redash.io/assets/images/logo.png' width="200px"/>
2014-09-17 13:04:30 +00:00
</p>
2013-10-27 09:24:02 +00:00
[![Documentation](https://img.shields.io/badge/docs-redash.io/help-brightgreen.svg)](https://redash.io/help/)
2019-06-02 11:01:09 +00:00
[![Datree](https://s3.amazonaws.com/catalog.static.datree.io/datree-badge-20px.svg)](https://datree.io/?src=badge)
![Build Status](https://circleci.com/gh/getredash/redash.png?circle-token=8a695aa5ec2cbfa89b48c275aea298318016f040)
2016-04-07 21:55:32 +00:00
**_Redash_** is our take on freeing the data within our company in a way that will better fit our culture and usage patterns.
2013-10-28 13:18:13 +00:00
Prior to **_Redash_**, we tried to use traditional BI suites and discovered a set of bloated, technically challenged and slow tools/flows. What we were looking for was a more hacker'ish way to look at data, so we built one.
2013-10-28 13:18:13 +00:00
**_Redash_** was built to allow fast and easy access to billions of records, that we process and collect using Amazon Redshift ("petabyte scale data warehouse" that "speaks" PostgreSQL).
2018-09-17 19:07:31 +00:00
Today **_Redash_** has support for querying multiple databases, including: Redshift, Google BigQuery, PostgreSQL, MySQL, Graphite, Presto, Google Spreadsheets, Cloudera Impala, Hive and custom scripts.
2013-10-27 09:24:02 +00:00
**_Redash_** consists of two parts:
2013-10-27 09:24:02 +00:00
2018-10-21 08:38:11 +00:00
1. **Query Editor**: think of [JS Fiddle](https://jsfiddle.net) for SQL queries. It's your way to share data in the organization in an open way, by sharing both the dataset and the query that generated it. This way everyone can peer review not only the resulting dataset but also the process that generated it. Also it's possible to fork it and generate new datasets and reach new insights.
2018-04-24 12:03:42 +00:00
2. **Visualizations and Dashboards**: once you have a dataset, you can create different visualizations out of it, and then combine several visualizations into a single dashboard. Currently Redash supports charts, pivot table, cohorts and [more](https://redash.io/help/user-guide/visualizations/visualization-types).
2013-10-27 09:24:02 +00:00
2018-04-24 12:04:31 +00:00
<img src="https://raw.githubusercontent.com/getredash/website/8e820cd02c73a8ddf4f946a9d293c54fd3fb08b9/website/_assets/images/redash-anim.gif" width="80%"/>
2013-10-30 10:37:33 +00:00
2013-10-30 11:10:16 +00:00
## Getting Started
2018-09-17 19:07:31 +00:00
* [Setting up Redash instance](https://redash.io/help/open-source/setup) (includes links to ready made AWS/GCE images).
* [Documentation](https://redash.io/help/).
2013-10-27 09:24:02 +00:00
2018-04-24 11:58:58 +00:00
## Supported Data Sources
Redash supports more than 35 [data sources](https://redash.io/help/data-sources/supported-data-sources).
2013-10-28 14:51:49 +00:00
2016-04-17 06:24:21 +00:00
## Getting Help
2013-10-28 14:51:49 +00:00
2016-04-17 06:24:21 +00:00
* Issues: https://github.com/getredash/redash/issues
* Discussion Forum: https://discuss.redash.io/
2013-10-27 09:24:02 +00:00
## Reporting Bugs and Contributing Code
2015-11-16 14:12:41 +00:00
* Want to report a bug or request a feature? Please open [an issue](https://github.com/getredash/redash/issues/new).
2017-09-22 16:51:10 +00:00
* Want to help us build **_Redash_**? Fork the project, edit in a [dev environment](https://redash.io/help-onpremise/dev/guide.html), and make a pull request. We need all the help we can get!
2013-10-27 09:24:02 +00:00
2018-09-17 19:07:31 +00:00
## Security
Please email security@redash.io to report any security vulnerabilities. We will acknowledge receipt of your vulnerability and strive to send you regular updates about our progress. If you're curious about the status of your disclosure please feel free to email us again. If you want to encrypt your disclosure email, you can use [this PGP key](https://keybase.io/arikfr/key.asc).
2013-10-27 09:24:02 +00:00
## License
BSD-2-Clause.