diff --git a/docs/installation.rst b/docs/installation.rst index f35b8c5b8..4cc223dcd 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -342,7 +342,7 @@ as well as the default values in place. Since ``superset_config.py`` acts as a Flask configuration module, it can be used to alter the settings Flask itself, -as well as Flask extensions like ``flask-wtf``, ``flask-cache``, +as well as Flask extensions like ``flask-wtf``, ``flask-caching``, ``flask-migrate``, and ``flask-appbuilder``. Flask App Builder, the web framework used by Superset offers many configuration settings. Please consult the `Flask App Builder Documentation @@ -365,12 +365,12 @@ auth postback endpoint, you can add them to *WTF_CSRF_EXEMPT_LIST* Caching ------- -Superset uses `Flask-Cache `_ for +Superset uses `Flask-Caching `_ for caching purpose. Configuring your caching backend is as easy as providing ``CACHE_CONFIG`` and ``DATA_CACHE_CONFIG`, constants in ``superset_config.py`` -that complies with `the Flask-Cache specifications `_. +that complies with `the Flask-Caching specifications `_. -Flask-Cache supports multiple caching backends (Redis, Memcached, +Flask-Caching supports multiple caching backends (Redis, Memcached, SimpleCache (in-memory), or the local filesystem). If you are going to use Memcached please use the `pylibmc` client library as `python-memcached` does not handle storing binary data correctly. If you use Redis, please install @@ -393,7 +393,7 @@ defined in ``DATA_CACHE_CONFIG``. It is also possible to pass a custom cache initialization function in the config to handle additional caching use cases. The function must return an -object that is compatible with the `Flask-Cache `_ API. +object that is compatible with the `Flask-Caching `_ API. .. code-block:: python diff --git a/docs/src/pages/docs/installation/caching.mdx b/docs/src/pages/docs/installation/caching.mdx index 4c9a22dae..9102b5bbc 100644 --- a/docs/src/pages/docs/installation/caching.mdx +++ b/docs/src/pages/docs/installation/caching.mdx @@ -8,15 +8,15 @@ version: 1 ## Caching -Superset uses [Flask-Cache](https://pythonhosted.org/Flask-Cache/) for caching purpose. For security reasons, +Superset uses [Flask-Caching](https://flask-caching.readthedocs.io/) for caching purpose. For security reasons, there are two separate cache configs for Superset's own metadata (`CACHE_CONFIG`) and charting data queried from connected datasources (`DATA_CACHE_CONFIG`). However, Query results from SQL Lab are stored in another backend called `RESULTS_BACKEND`, See [Async Queries via Celery](/docs/installation/async-queries-celery) for details. Configuring caching is as easy as providing `CACHE_CONFIG` and `DATA_CACHE_CONFIG` in your -`superset_config.py` that complies with [the Flask-Cache specifications](https://flask-caching.readthedocs.io/en/latest/#configuring-flask-caching). +`superset_config.py` that complies with [the Flask-Caching specifications](https://flask-caching.readthedocs.io/en/latest/#configuring-flask-caching). -Flask-Cache supports various caching backends, including Redis, Memcached, SimpleCache (in-memory), or the +Flask-Caching supports various caching backends, including Redis, Memcached, SimpleCache (in-memory), or the local filesystem. - Memcached: we recommend using [pylibmc](https://pypi.org/project/pylibmc/) client library as diff --git a/docs/src/pages/docs/installation/configuring.mdx b/docs/src/pages/docs/installation/configuring.mdx index daea083d2..6a07b2f48 100644 --- a/docs/src/pages/docs/installation/configuring.mdx +++ b/docs/src/pages/docs/installation/configuring.mdx @@ -47,7 +47,7 @@ can be altered in your local `superset_config.py`. Administrators will want to r to understand what can be configured locally as well as the default values in place. Since `superset_config.py` acts as a Flask configuration module, it can be used to alter the -settings Flask itself, as well as Flask extensions like `flask-wtf`, `flask-cache`, `flask-migrate`, +settings Flask itself, as well as Flask extensions like `flask-wtf`, `flask-caching`, `flask-migrate`, and `flask-appbuilder`. Flask App Builder, the web framework used by Superset, offers many configuration settings. Please consult the [Flask App Builder Documentation](https://flask-appbuilder.readthedocs.org/en/latest/config.html)