jprdonnelly/redash
1
0
Fork 0
mirror of https://github.com/getredash/redash.git synced 2025-12-25 01:03:20 -05:00
Code Issues Projects Releases Wiki Activity

Docs: re:dash -> Re:dash & new screenshots

Browse Source
This commit is contained in:
Arik Fraimovich
2016-04-15 23:26:21 +03:00
parent 807df66ae9
commit accb3d973d
12 changed files with 40 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/datasources.rst
View File

@@ -1,7 +1,7 @@
Supported Data Sources
######################
re:dash supports several types of data sources, and if you set it up using the provided images, it should already have
Re:dash supports several types of data sources, and if you set it up using the provided images, it should already have
the needed dependencies to use them all. Starting from version 0.7 and newer, you can manage data sources from the UI
by browsing to ``/data_sources`` on your instance.
@@ -132,7 +132,7 @@ format </dev/results_format>`.
Very useful in situations where you want to expose the data without
connecting directly to the database.
The query itself inside re:dash will simply contain the URL to be
The query itself inside Re:dash will simply contain the URL to be
executed (i.e. http://myserver/path/myquery)
- **Options**:
@@ -153,7 +153,7 @@ Google Spreadsheets
Notes:
1. To be able to load the spreadsheet in re:dash - share your it with
1. To be able to load the spreadsheet in Re:dash - share your it with
your ServiceAccount's email (it can be found in the credentials json
file, for example
43242343247-fjdfakljr3r2@developer.gserviceaccount.com).
@@ -248,7 +248,7 @@ Microsoft SQL Server
- **Notes**:
- Data type support is currently quite limited.
- Complex and new types are converted to strings in ``re:dash``
- Complex and new types are converted to strings in ``Re:dash``
- Coerce into simpler types if needed using ``CAST()``
- Known conversion issues for:
- DATE

6
docs/dev/query_execution.rst
View File

@@ -4,15 +4,15 @@ Query Execution Model
Introduction
============
The first datasource which was used with re:dash was Redshift. Because
The first datasource which was used with Re:dash was Redshift. Because
we had billions of records in Redshift, and some queries were costly to
re-run, from the get go there was the idea of caching query results in
re:dash.
Re:dash.
This was to relieve stress from the Redshift cluster and also to improve
user experience.
How queries get executed and cached in re:dash?
How queries get executed and cached in Re:dash?
===============================================
Server

2
docs/dev/results_format.rst
View File

@@ -1,7 +1,7 @@
Data Source Results Format
==========================
All data sources in re:dash return the following results in JSON format:
All data sources in Re:dash return the following results in JSON format:
.. code:: javascript

4
docs/dev/vagrant.rst
View File

@@ -3,7 +3,7 @@ Setting up development environment (using Vagrant)
To simplify contribution there is a `Vagrant
box <https://vagrantcloud.com/redash/boxes/dev>`__ available with all
the needed software to run re:dash for development (use it only for
the needed software to run Re:dash for development (use it only for
development, for demo purposes there is
`redash/demo <https://vagrantcloud.com/redash/boxes/demo>`__ box and the
AWS/GCE images).
@@ -12,7 +12,7 @@ To get started with this box:
1. Make sure you have recent version of
`Vagrant <https://www.vagrantup.com/>`__ installed.
2. Clone the re:dash repository:
2. Clone the Re:dash repository:
``git clone https://github.com/getredash/redash.git``.
3. Change dir into the repository (``cd redash``) and run run
``vagrant up``. This might take some time the first time you run it,

10
docs/index.rst
View File

@@ -4,11 +4,11 @@
Open Source Data Collaboration and Visualization Platform
===================================
**re:dash** is our take on freeing the data within our company in a way that will better fit our culture and usage patterns.
**Re:dash** is our take on freeing the data within our company in a way that will better fit our culture and usage patterns.
Prior to **re:dash**, 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.
Prior to **Re:dash**, 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.
**re:dash** 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).
**Re:dash** 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).
Today **_re:dash_** has support for querying multiple databases, including: Redshift, Google BigQuery,Google Spreadsheets, PostgreSQL, MySQL, Graphite and custom scripts.
Features
@@ -21,7 +21,7 @@ Features
Demo
####
.. figure:: https://raw.github.com/getredash/redash/screenshots/screenshots.gif
.. figure:: https://cloud.githubusercontent.com/assets/71468/12611424/1faf4d6a-c4f5-11e5-89b5-31efc1155d2c.gif
:alt: Screenshots
You can try out the demo instance: `http://demo.redash.io`_ (login with any Google account).
@@ -32,7 +32,7 @@ You can try out the demo instance: `http://demo.redash.io`_ (login with any Goog
Getting Started
###############
:doc:`Setting up re:dash instance </setup>` (includes links to ready made AWS/GCE images).
:doc:`Setting up Re:dash instance </setup>` (includes links to ready made AWS/GCE images).
Getting Help
############

10
docs/misc/backup_restore.rst
View File

@@ -1,9 +1,9 @@
How To: Backup your re:dash database and restore it on a different server
How To: Backup your Re:dash database and restore it on a different server
=================
**Note:** This guide assumes that the default database name (redash) has not been changed.
1. Check the size of your redash database. This can be done by creating a query within redash itself against the 're:dash metadata' data source.
1. Check the size of your redash database. This can be done by creating a query within redash itself against the 'Re:dash metadata' data source.
.. code::
@@ -28,7 +28,7 @@ How To: Backup your re:dash database and restore it on a different server
4. Transfer the backup to the new server.
5. `Perform a clean install of re:dash <http://docs.redash.io/en/latest/setup.html>`__ on the new server.
5. `Perform a clean install of Re:dash <http://docs.redash.io/en/latest/setup.html>`__ on the new server.
6. Check the amount of available disk space on the new server.
@@ -60,7 +60,7 @@ How To: Backup your re:dash database and restore it on a different server
psql -c "ALTER ROLE redash_reader WITH PASSWORD 'yourpasswordgoeshere';"
**Note:** Then you must navigate to the 're:dash metadata' data source (/data_sources/1) in the new re:dash installation and change the password to match the one entered above.
**Note:** Then you must navigate to the 'Re:dash metadata' data source (/data_sources/1) in the new Re:dash installation and change the password to match the one entered above.
10. Grant permissions on the redash database to the redash_reader user.
@@ -71,4 +71,4 @@ How To: Backup your re:dash database and restore it on a different server
psql -c "grant select on events, queries, dashboards, widgets, visualizations, query_results to redash_reader;" redash
Create a new query in redash (using re:dash metadata as the data source) to test that everything is working as expected.
Create a new query in redash (using Re:dash metadata as the data source) to test that everything is working as expected.

4
docs/misc/google_developers_project.rst
View File

@@ -29,8 +29,8 @@ How To: Create a Google Developers Project
application**.
- In the **Authorized JavaScript origins** field, enter the origin
for your app. You can enter multiple origins to use with multiple
re:dash instance. Wildcards are not allowed. In the example below,
we assume your re:dash instance address is *redash.example.com*:
Re:dash instance. Wildcards are not allowed. In the example below,
we assume your Re:dash instance address is *redash.example.com*:
::

2
docs/misc/letsencrypt.rst
View File

@@ -1,4 +1,4 @@
How To: Encrypt your re:dash installation with a free SSL certificate from Let's Encrypt
How To: Encrypt your Re:dash installation with a free SSL certificate from Let's Encrypt
=================
**Note:** This below steps were tested on Ubuntu 14.04, but *should* work with any Debian-based distro.

4
docs/settings.rst
View File

@@ -1,11 +1,11 @@
Settings
########
Much of the functionality of re:dash can be changes with settings. Settings are read by `/redash/settings.py` from environment variables which (for most installs) can be set in `/opt/redash/current/.env`
Much of the functionality of Re:dash can be changes with settings. Settings are read by `/redash/settings.py` from environment variables which (for most installs) can be set in `/opt/redash/current/.env`
The follow is a list of settings and what they control:
- **REDASH_NAME**: name of the site, used in page titles, *default "re:dash"*
- **REDASH_NAME**: name of the site, used in page titles, *default "Re:dash"*
- **REDASH_REDIS_URL**: *default "redis://localhost:6379/0"*
- **REDASH_PROXIES_COUNT**: *default "1"*
- **REDASH_STATSD_HOST**: *default "127.0.0.1"*

23
docs/setup.rst
View File

@@ -1,4 +1,4 @@
Setting up re:dash instance
Setting up Re:dash instance
###########################
The `provisioning
@@ -44,7 +44,7 @@ First, you need to add the images to your account:
$ gcloud compute images create "redash-091-b1377" --source-uri gs://redash-images/redash.0.9.1.b1377.tar.gz
Next you need to launch an instance using this image (n1-standard-1
instance type is recommended). If you plan using re:dash with BigQuery,
instance type is recommended). If you plan using Re:dash with BigQuery,
you can use a dedicated image which comes with BigQuery preconfigured
(using instance permissions):
@@ -90,12 +90,11 @@ Setup
=====
Once you created the instance with either the image or the script, you
should have a running re:dash instance with everything you need to get
started (e.g. When using the script mentioned in the setup page, the user should use port 80 as we install nginx. Redash itself listens on port 5000.
Port 9001 only used with the Vagrant installation). You can now login to it with the user "admin" (password:
"admin"). But to make it useful, there are a few more steps that you
need to manually do to complete the setup:
should have a running Re:dash instance with everything you need to get
started . Re:dash should be available using the server IP or DNS name
you assigned to it. You can point your browser to this address, and login
with the user "admin" (password: "admin"). But to make it useful, there are
a few more steps that you need to manually do to complete the setup:
First ssh to your instance and change directory to ``/opt/redash``. If
you're using the GCE image, switch to root (``sudo su``).
@@ -149,7 +148,7 @@ If you're passing multiple domains, separate them with commas.
Datasources
-----------
To make re:dash truly useful, you need to setup your data sources in it. Browse to ``/data_sources`` on your instance,
To make Re:dash truly useful, you need to setup your data sources in it. Browse to ``/data_sources`` on your instance,
to create new data source connection.
See :doc:`documentation </datasources>` for the different options.
@@ -159,7 +158,7 @@ Mail Configuration
------------------
For the system to be able to send emails (for example when alerts trigger), you need to set the mail server to use and the
host name of your re:dash server. If you're using one of our images, you can do this by editing the `.env` file:
host name of your Re:dash server. If you're using one of our images, you can do this by editing the `.env` file:
.. code::
@@ -173,7 +172,7 @@ host name of your re:dash server. If you're using one of our images, you can do
export REDASH_MAIL_PASSWORD="" # default: None
export REDASH_MAIL_DEFAULT_SENDER="" # Email address to send from
export REDASH_HOST="" # base address of your re:dash instance, for example: "https://demo.redash.io"
export REDASH_HOST="" # base address of your Re:dash instance, for example: "https://demo.redash.io"
- Note that not all values are required, as there are default values.
- It's recommended to use some mail service, like `Amazon SES <https://aws.amazon.com/ses/>`__, `Mailgun <http://www.mailgun.com/>`__
@@ -184,7 +183,7 @@ To test email configuration, you can run `bin/run ./manage.py send_test_mail` (f
How to upgrade?
---------------
It's recommended to upgrade once in a while your re:dash instance to
It's recommended to upgrade once in a while your Re:dash instance to
benefit from bug fixes and new features. See :doc:`here </upgrade>` for full upgrade
instructions (including Fabric script).

4
docs/upgrade.rst
View File

@@ -1,7 +1,7 @@
How to Upgrade
##############
It's recommended to upgrade your re:dash instance once there are new
It's recommended to upgrade your Re:dash instance once there are new
releases, to benefit from new features and bug fixes. The upgrade
process is relatively simple, and assuming you used one of the base
images we provide, you can just use the
@@ -14,7 +14,7 @@ How to run the Fabric script
1. Install Fabric: ``pip install fabric requests`` (needed only once)
2. Download the ``fabfile.py`` from the gist.
3. Run the script:
``fab -H{your re:dash host} -u{the ssh user for this host} -i{path to key file for passwordless login} deploy_latest_release``
``fab -H{your Re:dash host} -u{the ssh user for this host} -i{path to key file for passwordless login} deploy_latest_release``
``-i`` is optional and it is only needed in case you're using private-key based authentication (and didn't add the key file to your authentication agent or set its path in your SSH config).

4
docs/usage/maintenance.rst
View File

@@ -40,7 +40,7 @@ Changing the Number of Workers
==============================
By default, Celery will start a worker per CPU core. Because most of
re:dash's tasks are IO bound, the real limit for number of workers you
Re:dash's tasks are IO bound, the real limit for number of workers you
can use depends on the amount of memory your machine has. It's
recommended to increase number of workers, to support more concurrent
queries.
@@ -57,7 +57,7 @@ queries.
DB
==
Backup re:dash's DB:
Backup Re:dash's DB:
--------------------
Uncompressed backup: ``sudo -u redash pg_dump > backup_filename.sql``