chore: Docs and config improvements for Docker setup

[Vitor-Avila]

SUMMARY

Adding more docs on how to customize/extend Docker settings, and also adding more config files to .gitignore.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A

TESTING INSTRUCTIONS

Run docker compose build and docker compose up -d and confirm things still work proeprly.

ADDITIONAL INFORMATION

• Has associated issue:
• Required feature flags:
• Changes UI
• Includes DB Migration (follow approval process in SIP-59)
  • Migration is atomic, supports rollback & is backwards-compatible
  • Confirm DB migration upgrade and downgrade tested
  • Runtime estimates and downtime expectations provided
• Introduces new feature or API
• Removes existing feature or API

[bito-code-review]

Code Review Agent Run #71bc16

Actionable Suggestions - 0

Review Details

• Files reviewed - 1 · Commit Range: 156729c..156729c

  • Dockerfile
• Files skipped - 4

  • .gitignore - Reason: Filter setting
  • docker-compose.yml - Reason: Filter setting
  • docker/README.md - Reason: Filter setting
  • docker/superset-websocket/config.example.json - Reason: Filter setting
• Tools

  • Whispers (Secret Scanner) - ✔︎ Successful
  • Detect-secrets (Secret Scanner) - ✔︎ Successful

---

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

• /review - Manually triggers a full AI review.

• /pause - Pauses automatic reviews on this pull request.

• /resume - Resumes automatic reviews.

• /resolve - Marks all Bito-posted review comments as resolved.

• /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Default Agent You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

• Customize agent settings
• Review rules
• General documentation
• FAQ

AI Code Review powered by

[korbit-ai]

I've completed my review and didn't find any issues.

Check out our docs on how you can make Korbit work best for you and your team.

Loving Korbit!? Share us on LinkedIn Reddit and X

[bito-code-review]

Interaction Diagram by Bito

sequenceDiagram
participant Dev as Developer
participant DockerBuild as Docker Build Pipeline<br/>🔄 Updated | ●●○ Medium
participant Playwright as Playwright Module<br/>🔄 Updated | ●●○ Medium
participant Pillow as Pillow Dependency<br/>🔄 Updated | ●●○ Medium
participant WSConfig as WebSocket Config<br/>🔄 Updated | ●●○ Medium
participant WSService as WebSocket Service
participant Redis as Redis Cache
Dev->>DockerBuild: Build with INCLUDE_CHROMIUM/FIREFOX flags
DockerBuild->>Playwright: Set PLAYWRIGHT_BROWSERS_PATH env
Playwright->>Pillow: Install playwright + Pillow together
DockerBuild->>WSConfig: Mount config.example.json (read-only)
WSConfig->>WSService: Load WebSocket configuration
WSService->>Redis: Connect to Redis for async events
Redis-->>WSService: Return connection status
Note over Dev, WSConfig: Config overrides via .env-local and custom config.json (git-ignored)

Loading

Critical path: Developer->Docker Build Pipeline->Playwright Module->Pillow Dependency->WebSocket Config->WebSocket Service->Redis Cache

Note: Docker build now sets PLAYWRIGHT_BROWSERS_PATH and installs Pillow alongside Playwright for browser automation. WebSocket service config changed to use read-only example mount with optional custom config.json override pattern. Configuration documentation updated to support environment variable and WebSocket config overrides.

[sfirke]

Looks like you are adding Pillow to the base Docker image. I'm fine with that, and once this PR is in a major release I'll update https://superset.apache.org/docs/installation/docker-builds/ to remove Pillow as an add-on.

But are Playwright and Chrome still not installed in the python-common or lean layers by default? If that's still the case, then does it help to add Pillow here? I think of Pillow as being needed for Alerts & Reports but if someone has to install Playwright and Chrome anyway would they install it then? Just wondering, and maybe I'm off-base here.

[Vitor-Avila]

Looks like you are adding Pillow to the base Docker image. I'm fine with that, and once this PR is in a major release I'll update https://superset.apache.org/docs/installation/docker-builds/ to remove Pillow as an add-on.

Oh, you're right. I actually included it there just because in this example we have:

...
RUN . /app/.venv/bin/activate && \
    uv pip install \
    # install psycopg2 for using PostgreSQL metadata store - could be a MySQL package if using that backend:
    psycopg2-binary \
    # add the driver(s) for your data warehouse(s), in this example we're showing for Microsoft SQL Server:
    pymssql \
    # package needed for using single-sign on authentication:
    Authlib \
    # openpyxl to be able to upload Excel files
    openpyxl \
    # Pillow for Alerts & Reports to generate PDFs of dashboards
    Pillow \
    # install Playwright for taking screenshots for Alerts & Reports. This assumes the feature flag PLAYWRIGHT_REPORTS_AND_THUMBNAILS is enabled
    # That feature flag will default to True starting in 6.0.0
    # Playwright works only with Chrome.
    # If you are still using Selenium instead of Playwright, you would instead install here the selenium package and a headless browser & webdriver
    playwright \
    && playwright install-deps \
    && PLAYWRIGHT_BROWSERS_PATH=/usr/local/share/playwright-browsers playwright install chromium

...

I saw there "Pillow for Alerts & Reports to generate PDFs of dashboards" and thought it was also needed for PDF reports which we want to use Playwright as well.

Let me remove that part -- thanks for catching it!

[Vitor-Avila]

But are Playwright and Chrome still not installed in the python-common or lean layers by default? If that's still the case, then does it help to add Pillow here? I think of Pillow as being needed for Alerts & Reports but if someone has to install Playwright and Chrome anyway would they install it then? Just wondering, and maybe I'm off-base here.

I had trouble getting Playwright to work out of the box with docker compose. Adding INCLUDE_CHROMIUM=true in the .env-local was not sufficient, I had to include it in the command (INCLUDE_CHROMIUM=true docker compose), so tackled that using a docker-compose.override.yml file.

As for the use-cases, you're correct. It's possible the user is only focusing on Alerts & Reports (which can use Playwright) or on the other hand just looking to have async PDF download in dashboards.