7577f47706
* fixed whitespace * commit exclusion of package-lock from large file size precommit hook * Converted all PNG files to JPG files to save space, stay under <500kb file size * added link to release notes for 1.0 |
||
|---|---|---|
| .. | ||
| pythonpath_dev | ||
| .env | ||
| README.md | ||
| docker-bootstrap.sh | ||
| docker-entrypoint.sh | ||
| docker-frontend.sh | ||
| docker-init.sh | ||
| frontend-mem-nag.sh | ||
README.md
Getting Started with Superset using Docker
Docker is an easy way to get started with Superset.
Prerequisites
Configuration
The /app/pythonpath folder is mounted from ./docker/pythonpath_dev
which contains a base configuration ./docker/pythonpath_dev/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_dev/superset_config_local.example into ./docker/pythonpath_dev/superset_config_docker.py (git ignored) and fill in your overrides.
Local packages
If you want to add python packages in order to test things like DBs locally, you can simply add a local requirements.txt (./docker/requirements-local.txt) and rebuild your docker stack.
Steps:
1. Create ./docker/requirements-local.txt
2. Add your new packages
3. Rebuild docker-compose
a. docker-compose down -v
b. docker-compose up
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)