GitHub user dosubot[bot] added a comment to the discussion: How to install and configure superset step by step??
<!-- Answer --> Apache Superset is not officially supported for native Windows installation. The recommended way to run it on Windows is using Docker Compose or Windows Subsystem for Linux (WSL) for best compatibility. Here’s how you can get started and configure it with superset_config.py: **Prerequisites**: - Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) for Windows (which includes Docker Compose) - Install [git](https://git-scm.com/) - (Optional but recommended) Install WSL with Ubuntu for fewer compatibility issues --- ### Step-by-step: Install with Docker Compose 1. **Clone the Superset repo** Open a terminal (e.g., Command Prompt, PowerShell, or Git Bash) and run: ``` git clone https://github.com/apache/superset.git cd superset ``` 2. **Start Superset with Docker Compose** ``` docker compose up --build ``` This will build and start all required services. The first build may take several minutes. 3. **Access Superset** Once running, open http://localhost:8088 in your browser. Default login: `admin` / `admin` [Source](https://github.com/apache/superset/issues/32011) --- **Troubleshooting (Windows-specific):** If you see errors about `node_modules` or missing frontend packages, delete any `node_modules` folders in `superset-frontend` on your host, then run: ``` docker compose down -v docker compose up --build ``` If issues persist, try using `compose-non-dev.yml` or `compose-image-tag.yml` instead of the default compose file to avoid mounting local code, which can cause problems on Windows. [Source](https://github.com/apache/superset/issues/34225) --- ### Alternative: Install with WSL - Install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) and Ubuntu from the Microsoft Store. - Follow the standard Linux installation instructions inside your Ubuntu shell. This method avoids most Windows compatibility issues. --- ### Configuring with `superset_config.py` 1. **Create your `superset_config.py`** Example: ```python SECRET_KEY = 'YOUR_OWN_RANDOM_GENERATED_SECRET_KEY' # Example: openssl rand -base64 42 SQLALCHEMY_DATABASE_URI = 'sqlite:///C:/superset_data/superset.db' # Add other config overrides as needed ``` 2. **Tell Superset where to find it** Set the `SUPERSET_CONFIG_PATH` environment variable to the full path of your `superset_config.py`. In PowerShell: ``` $env:SUPERSET_CONFIG_PATH="C:\path\to\superset_config.py" ``` In Command Prompt: ``` set SUPERSET_CONFIG_PATH=C:\path\to\superset_config.py ``` Restart Superset after setting this variable. [Source](https://github.com/apache/superset/blob/829e4d92d91ceae4b43b1ed3b063ffe45377799c/docs/docs/configuration/configuring-superset.mdx) 3. **Verify your config is loaded** When Superset starts, you should see a message like: ``` Loaded your LOCAL configuration at [C:\path\to\superset_config.py] ``` If you don’t set a strong `SECRET_KEY`, Superset will refuse to start in production mode. --- **Best practices:** - Use Docker Compose or WSL for the smoothest experience on Windows. - Always set a strong, unique `SECRET_KEY` in your config. - For production, use PostgreSQL or MySQL as your metadata database instead of SQLite. - Keep your `superset_config.py` outside the repo and never commit secrets to version control. For more details, see the [official configuration guide](https://github.com/apache/superset/blob/829e4d92d91ceae4b43b1ed3b063ffe45377799c/docs/docs/configuration/configuring-superset.mdx) and [Docker Compose instructions](https://github.com/apache/superset/blob/829e4d92d91ceae4b43b1ed3b063ffe45377799c/docs/docs/installation/docker-compose.mdx). <!-- Dosu Comment Footer --> *To reply, just mention [@dosu](https://go.dosu.dev/dosubot).* --- <sup>How did I do? [Good](https://app.dosu.dev/response-feedback/1bd8120d-1c40-4b93-a137-6d18e5a306c2?feedback_type=great_response) | [Irrelevant](https://app.dosu.dev/response-feedback/1bd8120d-1c40-4b93-a137-6d18e5a306c2?feedback_type=irrelevant_answer) | [Incorrect](https://app.dosu.dev/response-feedback/1bd8120d-1c40-4b93-a137-6d18e5a306c2?feedback_type=incorrect_sources) | [Verbose](https://app.dosu.dev/response-feedback/1bd8120d-1c40-4b93-a137-6d18e5a306c2?feedback_type=too_verbose) | [Hallucination](https://app.dosu.dev/response-feedback/1bd8120d-1c40-4b93-a137-6d18e5a306c2?feedback_type=hallucination) | [Report 🐛](https://app.dosu.dev/response-feedback/1bd8120d-1c40-4b93-a137-6d18e5a306c2?feedback_type=bug_report) | [Other](https://app.dosu.dev/response-feedback/1bd8120d-1c40-4b93-a137-6d18e5a306c2?feedback_type=other)</sup> [](https://app.dosu.dev/a28d3c7e-a9d3-459e-9fb6-3a6f9ff4f357/ask?utm_source=github)& nbsp;[](https://go.dosu.dev/discord-bot) [](https://twitter.com/intent/tweet?text=%40dosu_ai%20helped%20me%20solve%20this%20issue!&url=https%3A//github.com/apache/superset/discussions/34439) GitHub link: https://github.com/apache/superset/discussions/34439#discussioncomment-13953206 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
