From a029eaa4512ab791ff8e461c9ba2cefc8000bbfa Mon Sep 17 00:00:00 2001 From: Riccardo Magliocchetti Date: Wed, 17 Aug 2016 17:04:39 +0200 Subject: [PATCH] docs: add a faq about mapbox api key (#968) Also add it to sample config Fix #952 --- docs/faq.rst | 7 +++++++ docs/installation.rst | 3 +++ 2 files changed, 10 insertions(+) diff --git a/docs/faq.rst b/docs/faq.rst index 18021e7c4d..6dc15da22a 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -54,3 +54,10 @@ increase the default (50), you can specify the timeout when starting the web server with the ``-t`` flag, which is expressed in seconds. ``caravel runserver -t 300`` + + +Why is the map not visible in the mapbox visualization? +------------------------------------------------------- + +You need to register to mapbox.com, get an API key and configure it as +``MAPBOX_API_KEY`` in ``caravel_config.py``. diff --git a/docs/installation.rst b/docs/installation.rst index 4b050691df..a2bffb4d1c 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -141,6 +141,9 @@ of the parameters you can copy / paste in that configuration module: :: # Flask-WTF flag for CSRF CSRF_ENABLED = True + # Set this API key to enable Mapbox visualizations + MAPBOX_API_KEY = '' + This file also allows you to define configuration parameters used by Flask App Builder, the web framework used by Caravel. Please consult the `Flask App Builder Documentation