History

Craig Rueda e9b0095754 Docker-Compose Memory Issue Fix? (#9285 ) * Adding free memory nag / running npm build with development options in compose * Adding license		2020-03-13 09:25:54 -07:00
..
pythonpath_dev	Ease switching of database engines for docker builds (#8863 )	2019-12-20 10:57:33 +00:00
.env	[docker] fix: for #8880 (#8882 )	2019-12-22 22:07:50 +00:00
README.md	Docker support (#8725 )	2019-12-03 18:37:18 +00:00
docker-entrypoint.sh	Fixing default Dockerfile entrypoint. Gunicorn needed a few tweaks (#8744 )	2019-12-04 13:13:15 -08:00
docker-init.sh	Moving appbuilder.xxx out of view files and into app.py (#8912 )	2020-01-08 18:04:05 +00:00
frontend-mem-nag.sh	Docker-Compose Memory Issue Fix? (#9285 )	2020-03-13 09:25:54 -07:00
requirements-extra.txt	Docker support (#8725 )	2019-12-03 18:37:18 +00:00

README.md

Getting Started with Superset using Docker

Docker is an easy way to get started with Superset.

Prerequisites

Docker! link
Docker-compose link

Configuration

The /app/pythonpath folder is mounted from ./docker/pythonpath_dev which contains a base configuration ./docker/pythonpath/superset_config.py intended for use with local development.

Local overrides

In order to override configuration settings locally, simply make a copy of ./docker/pythonpath/superset_config_local.example into ./docker/pythonpath/superset_config_docker.py (git ignored) and fill in your overrides.

Initializing Database

The DB will initialize itself upon startup via the init container (superset-init) (This may take a minute.)

Normal Operation

To run the container, simply run:

docker-compose up

After several minutes for superset initialization to finish, you can open a browser and view http://localhost:8088 to start your journey.

Developing

While running, the container server will reload on modification of the superset python and javascript source code. Don't forget to reload the page to take the new frontend into account though.

Production

It is also possible to run Superset in non-development mode: in the docker-compose.yml file remove the volumes needed for development and change the variable SUPERSET_ENV to production.

Resource Constraints

If you are attempting to build on a Mac and it exits with 137 you need to increase your docker resources. OSX instructions: https://docs.docker.com/docker-for-mac/#advanced (Search for memory)