# ![Superset](<https://daemonless.io/images/logos/superset.svg>) Superset

[![Build Status](<https://img.shields.io/github/actions/workflow/status/daemonless/superset/build.yaml?style=flat-square&amp;label=Build&amp;color=green>)](<https://github.com/daemonless/superset/actions>) [![Last Commit](<https://img.shields.io/github/last-commit/daemonless/superset?style=flat-square&amp;label=Last+Commit&amp;color=blue>)](<https://github.com/daemonless/superset/commits>) [![OCI Pulls](<https://img.shields.io/docker/pulls/daemonless/superset?style=flat-square&amp;label=OCI+Pulls&amp;color=blue>)](<https://hub.docker.com/r/daemonless/superset>)

Modern data exploration and visualization platform — build charts, dashboards, and SQL-driven analytics on top of your databases.

[[![Superset screenshot 1](<https://daemonless.io/images/screenshots/superset/68747470733a2f2f73757065727365742e6170616368652e6f72672f696d672f73637265656e73686f74732f64617368626f6172642e6a7067.jpg>)](</images/screenshots/superset/68747470733a2f2f73757065727365742e6170616368652e6f72672f696d672f73637265656e73686f74732f64617368626f6172642e6a7067.jpg>)](</images/screenshots/superset/68747470733a2f2f73757065727365742e6170616368652e6f72672f696d672f73637265656e73686f74732f64617368626f6172642e6a7067.jpg>) [[![Superset screenshot 2](<https://daemonless.io/images/screenshots/superset/68747470733a2f2f73757065727365742e6170616368652e6f72672f696d672f73637265656e73686f74732f67616c6c6572792e6a7067.jpg>)](</images/screenshots/superset/68747470733a2f2f73757065727365742e6170616368652e6f72672f696d672f73637265656e73686f74732f67616c6c6572792e6a7067.jpg>)](</images/screenshots/superset/68747470733a2f2f73757065727365742e6170616368652e6f72672f696d672f73637265656e73686f74732f67616c6c6572792e6a7067.jpg>) [[![Superset screenshot 3](<https://daemonless.io/images/screenshots/superset/hero-screenshot.jpg>)](</images/screenshots/superset/hero-screenshot.jpg>)](</images/screenshots/superset/hero-screenshot.jpg>)

|  |  |
| --- | --- |
| **Port** | `8088` |
| **Registry** | [`ghcr.io/daemonless/superset`](<https://github.com/daemonless/superset/pkgs/container/superset>) |
| **Daemonless** | [daemonless/superset](<https://github.com/daemonless/superset>) |
| **Source** | [apache/superset](<https://github.com/apache/superset>) |
| **Website** | [superset.apache.org](<https://superset.apache.org/>) |

### Redis caching

Set `REDIS_URL` to enable Redis-backed caching, e.g. with [daemonless/redis](<https://daemonless.io/images/redis>) on the same host (`network_mode: host` — inter-container DNS is not available on FreeBSD podman):

```
services:
  superset:
    image: ghcr.io/daemonless/superset:latest
    container_name: superset
    restart: unless-stopped
    network_mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - REDIS_URL=redis://localhost:6379/0
    volumes:
      - /containers/superset:/config
    depends_on:
      - redis

  redis:
    image: ghcr.io/daemonless/redis:latest
    container_name: superset_redis
    restart: unless-stopped
    network_mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - /containers/superset-redis:/config
```

### CSV / file uploads

Uploads require a database connection with **Allow file uploads to database** enabled (edit the database → Advanced → Security). To use a local SQLite playground database as the upload target, start the container with `SUPERSET_ALLOW_SQLITE=true`.

## Prerequisites

Before deploying, ensure your host environment is ready. See the [Quick Start Guide](<https://daemonless.io/guides/quick-start/index.md>) for host setup instructions, including the security model for host vs. container privileges.

## Deployment

**Customize Paths, UID &amp; Ports**

Install and manage **Superset** on FreeBSD with [fjord](<https://fjord.daemonless.io>):

```
fjord install superset
```

Or open the **App Store** in the fjord web UI and install **Superset** from the wizard. New to fjord? See the [Install Guide](<https://fjord.daemonless.io/install/>).

```
services:
  superset:
    image: "ghcr.io/daemonless/superset:latest"
    container_name: superset
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      # - SUPERSET_SECRET_KEY=  # Flask SECRET_KEY; auto-generated and persisted to /config/.secret_key when unset
      # - SUPERSET_ADMIN_USERNAME=  # Admin username to ensure on startup (default: admin)
      # - SUPERSET_ADMIN_PASSWORD=  # When set, creates/ensures the admin user on startup
      # - SUPERSET_ADMIN_EMAIL=  # Admin email (default: admin@example.com)
      # - SUPERSET_WORKERS=  # Gunicorn worker count (default: 2)
      # - DATABASE_URL=  # Metadata database URI (default: sqlite:////config/superset.db)
      # - REDIS_URL=  # Redis URL for caching
    volumes:
      - "/containers/superset:/config"
    ports:
      - "8088:8088"
    healthcheck:
      test: ["CMD", "{'port': 8088, 'path': '/health'}"]
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always
```

Save as `compose.yaml`, then run `podman-compose up -d`.

> [!WARNING]
>
> Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

```
# .env

DIRECTOR_PROJECT=superset
PUID=1000
PGID=1000
TZ=UTC
```

```
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  superset:
    name: superset
    options:
      - container: 'args:--pull'
      - expose: '8088:8088 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - superset: /config
volumes:
  superset:
    device: '/containers/superset'
```

```
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/superset:${tag}
```

Save the files above, then run `appjail-director up`.

> [!WARNING]
>
> **Experimental**
>
> Bastille's OCI support is experimental. It requires `buildah` and shares the host network stack (`inherit`). Mount volumes with `--volume HOST JAIL`; without it, image-declared volumes are stored under `${bastille_volumesdir}/${jail}`.

```
services:
  superset:
    name: superset
    image: "ghcr.io/daemonless/superset:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/containers/superset:/config"
```

Save as `bastille-compose.yml`, then run `bastille up`.

Open `http://<server>:8088` from another machine (the server's own browser can't use a published port).

## Parameters

### Environment Variables

| Variable | Default | Description |
| --- | --- | --- |
| `PUID` | `1000` | User ID for the application process |
| `PGID` | `1000` | Group ID for the application process |
| `TZ` | `UTC` | Timezone for the container |
| `SUPERSET_SECRET_KEY` | `<SUPERSET_SECRET_KEY>` | Flask SECRET\_KEY; auto-generated and persisted to /config/.secret\_key when unset |
| `SUPERSET_ADMIN_USERNAME` | \`\` | Admin username to ensure on startup (default: admin) |
| `SUPERSET_ADMIN_PASSWORD` | `<SUPERSET_ADMIN_PASSWORD>` | When set, creates/ensures the admin user on startup |
| `SUPERSET_ADMIN_EMAIL` | \`\` | Admin email (default: [admin@example.com](<mailto:admin@example.com>)) |
| `SUPERSET_WORKERS` | \`\` | Gunicorn worker count (default: 2) |
| `DATABASE_URL` | \`\` | Metadata database URI (default: sqlite:////config/superset.db) |
| `REDIS_URL` | \`\` | Redis URL for caching |

### Volumes

| Path | Description |
| --- | --- |
| `/config` | Superset home: metadata DB, secret key, uploads |

### Ports

| Port | Protocol | Description |
| --- | --- | --- |
| `8088` | TCP | Web UI |

## Version Tags

| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest` | **Upstream Binary**. Built from official release. | Most users — recommended. |

> [!NOTE]
>
> **Implementation Details**
>
> - **Architectures:** amd64
> - **User:** `bsd` (UID/GID set via [PUID/PGID](<https://daemonless.io/guides/permissions/index.md>)). Defaults to `1000:1000`.
> - **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD 15.1).

---

Need help? Join our [Discord](<https://discord.gg/Kb9tkhecZT>) community.
