-
-
Caravel’s documentation¶
-Caravel is a data exploration platform designed to be visual, intuitive +
+
- OS dependencies
- Python virtualenv
- Python’s setup tools and pip
-- Caravel installation and initialization
+- Superset installation and initialization
- Configuration behind a load balancer
- Configuration
- Database dependencies
@@ -265,6 +265,7 @@ to the user
- SQL Lab
diff --git a/installation.html b/installation.html
index 73da62adeee..84216069e43 100644
--- a/installation.html
+++ b/installation.html
@@ -8,7 +8,7 @@
- Installation & Configuration — Caravel's documentation documentation
+ Installation & Configuration — Superset's documentation documentation
@@ -33,9 +33,9 @@
-
+
-
+
@@ -53,7 +53,7 @@
- Caravel's documentation
+ Superset's documentation
@@ -83,7 +83,7 @@
- OS dependencies
- Python virtualenv
- Python’s setup tools and pip
-- Caravel installation and initialization
+- Superset installation and initialization
- Configuration behind a load balancer
- Configuration
- Database dependencies
@@ -117,6 +117,7 @@
- SQL Lab
Superset’s documentation¶
+Superset is a data exploration platform designed to be visual, intuitive and interactive.
-
Warning
This project used to be named Panoramix and has been renamed -to Caravel in March 2016
+to Superset in March 2016Overview¶
@@ -241,7 +241,7 @@ to the user- Feature Overview +
- Extra features
- Templating with Jinja
@@ -165,7 +166,7 @@
@@ -198,16 +199,16 @@
Installation & Configuration¶
Getting Started¶
-Caravel is tested using Python 2.7 and Python 3.4+. Python 3 is the recommended version, +
Superset is tested using Python 2.7 and Python 3.4+. Python 3 is the recommended version, Python 2.6 won’t be supported.
-OS dependencies¶
-Caravel stores database connection information in its metadata database. +
Superset stores database connection information in its metadata database. For that purpose, we use the
cryptographyPython library to encrypt connection passwords. Unfortunately this library has OS level dependencies.You may want to attempt the next step -(“Caravel installation and initialization”) and come back to this step if +(“Superset installation and initialization”) and come back to this step if you encounter an error.
Here’s how to install them:
For Debian and Ubuntu, the following command will ensure that @@ -237,7 +238,7 @@ attempt it, download
Python virtualenv¶
-It is recommended to install Caravel inside a virtualenv. Python 3 already ships virtualenv, for +
It is recommended to install Superset inside a virtualenv. Python 3 already ships virtualenv, for Python 2 you need to install it. If it’s packaged for your operating systems install it from there otherwise you can install from pip:
pip install virtualenv @@ -264,65 +265,65 @@ and
setuptoolsli-Caravel installation and initialization¶
-Follow these few simple steps to install Caravel.:
-# Install caravel -pip install caravel +
+Superset installation and initialization¶
+Follow these few simple steps to install Superset.:
+# Install superset +pip install superset # Create an admin user -fabmanager create-admin --app caravel +fabmanager create-admin --app superset # Initialize the database -caravel db upgrade +superset db upgrade # Load some data to play with -caravel load_examples +superset load_examples # Create default roles and permissions -caravel init +superset init # Start the web server on port 8088 -caravel runserver -p 8088 +superset runserver -p 8088 # To start a development web server, use the -d switch -# caravel runserver -d +# superset runserver -d
After installation, you should be able to point your browser to the right hostname:port http://localhost:8088, login using the credential you entered while creating the admin account, and navigate to Menu -> Admin -> Refresh Metadata. This action should bring in all of -your datasources for Caravel to be aware of, and they should show up in +your datasources for Superset to be aware of, and they should show up in Menu -> Datasources, from where you can start playing with your data!
-Please note that gunicorn, Caravel default application server, does not +
Please note that gunicorn, Superset default application server, does not work on Windows so you need to use the development web server. The development web server though is not intended to be used on production systems so better use a supported platform that can run gunicorn.
Configuration behind a load balancer¶
-If you are running caravel behind a load balancer or reverse proxy (e.g. NGINX +
If you are running superset behind a load balancer or reverse proxy (e.g. NGINX or ELB on AWS), you may need to utilise a healthcheck endpoint so that your -load balancer knows if your caravel instance is running. This is provided +load balancer knows if your superset instance is running. This is provided at
/healthwhich will return a 200 response containing “OK” if the webserver is running.If the load balancer is inserting X-Forwarded-For/X-Forwarded-Proto headers, you -should set ENABLE_PROXY_FIX = True in the caravel config file to extract and use +should set ENABLE_PROXY_FIX = True in the superset config file to extract and use the headers.
Configuration¶
To configure your application, you need to create a file (module) -
caravel_config.pyand make sure it is in your PYTHONPATH. Here are some +superset_config.pyand make sure it is in your PYTHONPATH. Here are some of the parameters you can copy / paste in that configuration module:#--------------------------------------------------------- -# Caravel specific config +# Superset specific config #--------------------------------------------------------- ROW_LIMIT = 5000 -CARAVEL_WORKERS = 4 +SUPERSET_WORKERS = 4 -CARAVEL_WEBSERVER_PORT = 8088 +SUPERSET_WEBSERVER_PORT = 8088 #--------------------------------------------------------- #--------------------------------------------------------- @@ -333,10 +334,10 @@ of the parameters you can copy / paste in that configuration module: # The SQLAlchemy connection string to your database backend # This connection defines the path to the database that stores your -# caravel metadata (slices, connections, tables, dashboards, ...). +# superset metadata (slices, connections, tables, dashboards, ...). # Note that the connection information to connect to the datasources # you want to explore are managed directly in the web UI -SQLALCHEMY_DATABASE_URI = 'sqlite:////path/to/caravel.db' +SQLALCHEMY_DATABASE_URI = 'sqlite:////path/to/superset.db' # Flask-WTF flag for CSRF CSRF_ENABLED = True @@ -346,22 +347,22 @@ of the parameters you can copy / paste in that configuration module:
This file also allows you to define configuration parameters used by -Flask App Builder, the web framework used by Caravel. Please consult +Flask App Builder, the web framework used by Superset. Please consult the Flask App Builder Documentation -for more information on how to configure Caravel.
+for more information on how to configure Superset.Please make sure to change:
-
-
- SQLALCHEMY_DATABASE_URI, by default it is stored at ~/.caravel/caravel.db +
- SQLALCHEMY_DATABASE_URI, by default it is stored at ~/.superset/superset.db
- SECRET_KEY, to a long random string
Database dependencies¶
-Caravel does not ship bundled with connectivity to databases, except +
Superset does not ship bundled with connectivity to databases, except for Sqlite, which is part of the Python standard library. You’ll need to install the required packages for the database you want to use as your metadata database as well as the packages needed to -connect to the databases you want to access through Caravel.
+connect to the databases you want to access through Superset.Here’s a list of some of the recommended packages.
