acfdd22c21
Fix two follow-on issues reported when starting the dev stack with docker-compose-mysql.yml: 1. ``superset-init`` step 4 (load-examples) fails with ``MySQLdb.OperationalError: (2002, "Can't connect to server on 'db'")`` because the analytics-examples DB connection inherits ``EXAMPLES_PORT=5432`` (Postgres port) from ``docker/.env``. The override flipped ``DATABASE_DIALECT`` to ``mysql+mysqldb`` but left the EXAMPLES_* group on Postgres defaults, so the URI became ``mysql+mysqldb://examples:examples@db:5432/examples`` — MySQL container has no listener on 5432. Fix: add ``EXAMPLES_HOST/PORT/DB/USER/PASSWORD`` and a complete ``SUPERSET__SQLALCHEMY_EXAMPLES_URI`` to the ``mysql-env`` anchor. 2. The Postgres init scripts under ``docker/docker-entrypoint-initdb.d/`` (``cypress-init.sh``, ``examples-init.sh``) get mounted on the MySQL container too — compose merges volume lists. They invoke ``psql`` which doesn't exist in the MySQL image, abort with ``psql: command not found``, and prevent the ``examples`` DB from being created. Fix: add a MySQL-specific init script ``docker/mysql-init/examples-init.sql`` that creates the ``examples`` database and user, and mount it at ``/docker-entrypoint-initdb.d`` in the override. Compose's later-takes-precedence rule on duplicate volume targets displaces the Postgres init dir, so the MySQL container only sees the MySQL-compatible script. (Used a plain duplicate-target mount rather than the ``!override`` tag because pre-commit's ``check-yaml`` doesn't recognize Compose's custom YAML tags.) Recovery for an existing failed MySQL stack: ``docker compose -f docker-compose.yml -f docker-compose-mysql.yml down``, then ``docker volume rm superset_db_home_mysql`` (so the new init script runs on the next fresh boot), then ``up`` again. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Environment Variables
To override environment variables locally, create a ./docker/.env-local file (git-ignored). This file will be loaded after .env and can override any settings.
Python Configuration
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.
WebSocket Configuration
To customize the WebSocket server configuration, create ./docker/superset-websocket/config.json (git-ignored) based on ./docker/superset-websocket/config.example.json.
Then update the superset-websocket.volumes config to mount it.
Docker Compose Overrides
For advanced Docker Compose customization, create a docker-compose-override.yml file (git-ignored) to override or extend services without modifying the main compose file.
Local packages
If you want to add Python packages in order to test things like databases locally, you can simply add a local requirements.txt (./docker/requirements-local.txt)
and rebuild your Docker stack.
Steps:
- Create
./docker/requirements-local.txt - Add your new packages
- Rebuild docker compose
docker compose down -vdocker compose up
Initializing Database
The database 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 waiting several minutes for Superset initialization to finish, you can open a browser and view http://localhost:8088
to start your journey.
Running Multiple Instances
If you need to run multiple Superset instances simultaneously (e.g., different branches or clones), use the make targets which automatically find available ports:
make up
This automatically:
- Generates a unique project name from your directory
- Finds available ports (incrementing from defaults if in use)
- Displays the assigned URLs before starting
Available commands (run from repo root):
| Command | Description |
|---|---|
make up |
Start services (foreground) |
make up-detached |
Start services (background) |
make down |
Stop all services |
make ps |
Show running containers |
make logs |
Follow container logs |
make nuke |
Stop, remove volumes & local images |
From a subdirectory, use: make -C $(git rev-parse --show-toplevel) up
Important: Always use these commands instead of plain docker compose down, which won't know the correct project name.
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 possible to run Superset in non-development mode by using docker-compose-non-dev.yml. This file excludes the volumes needed for development.
Resource Constraints
If you are attempting to build on macOS and it exits with 137 you need to increase your Docker resources. See instructions here (search for memory)