mirror of
https://github.com/apache/superset.git
synced 2026-05-22 08:15:36 +00:00
04451766e7
Previously docusaurus.config.ts had `onBrokenLinks: 'warn'`, so broken
internal links produced advisory warnings during build but didn't gate
merges. Tightening to `throw` surfaces every broken internal route at
build time. Three classes of issue fell out:
1. Stale `/docs/...` and `/docs/6.0.0/...` references in the 6.0.0
versioned snapshot. The user-facing docs section was renamed
`docs` → `user-docs` (routeBasePath) at some point after 6.0.0 was
cut, but the snapshot's links still pointed at the old prefix. The
live site redirects /docs/* → /user-docs/* at runtime, but
Docusaurus's onBrokenLinks checker doesn't honor redirects.
Bulk-rewrote /docs/* → /user-docs/* across the snapshot (and one
/docs/api → /developer-docs/api).
2. Bare-relative MDX links like `[Label](./mcp)` (no .md/.mdx
extension). Docusaurus renders an absolute href in SSR HTML, so
static crawlers see correct links — BUT React Router's `<Link>`
component on the client side resolves the bare path relative to
the current URL on click, so when the page URL has a trailing
slash (e.g. /extensions/overview/), `./mcp` becomes
/extensions/overview/mcp (404). This is exactly the broken-flow a
user reported on /developer-docs/extensions/overview/. Added the
`.md`/`.mdx` extension to all 44 such links across 17 files; this
makes Docusaurus resolve them to the canonical doc URL at the
<Link> level, so SPA navigation works regardless of trailing slash.
3. Miscellaneous content fixes:
- 4 `/configuration/feature-flags` references in 6.0.0 snapshot
pointed at a page that doesn't exist in that version (the
dedicated feature-flags page was added later). Repointed to the
`#feature-flags` anchor inside `configuring-superset.mdx`.
- 3 references to `superset-core/src/superset_core/rest_api/decorators.py`
in extensions docs were rendered as relative URLs, resolving to
/developer-docs/extensions/superset-core/... (404). Converted to
absolute GitHub URLs.
- 1 `/storybook/?path=...` link in extensions/components/index.mdx
pointed at a non-existent route. Repointed to the existing
`/developer-docs/testing/storybook` page that explains how to
run Storybook locally.
- 4 unclosed-paren markdown links in 6.0.0 installation-methods.mdx
(pre-existing source bugs).
Build now passes with `onBrokenLinks: 'throw'`. Note that
`onBrokenAnchors` is still `'warn'` (default); a separate effort
should tighten that and fix the surviving anchor warnings (currently
~60 instances of `/community#superset-community-calendar`).
83 lines
2.7 KiB
Plaintext
83 lines
2.7 KiB
Plaintext
---
|
|
title: Quickstart
|
|
hide_title: false
|
|
sidebar_position: 2
|
|
---
|
|
|
|
**Ready to try Apache Superset?** This quickstart guide will help you
|
|
get up and running on your local machine in **3 simple steps**. Note that
|
|
it assumes that you have [Docker](https://www.docker.com),
|
|
[Docker Compose](https://docs.docker.com/compose/), and
|
|
[Git](https://git-scm.com/) installed.
|
|
|
|
:::caution
|
|
Although we recommend using `Docker Compose` for a quick start in a sandbox-type
|
|
environment and for other development-type use cases, **we
|
|
do not recommend this setup for production**. For this purpose please
|
|
refer to our
|
|
[Installing on Kubernetes](/user-docs/6.0.0/installation/kubernetes/)
|
|
page.
|
|
:::
|
|
|
|
### 1. Get Superset
|
|
|
|
```bash
|
|
git clone https://github.com/apache/superset
|
|
```
|
|
|
|
### 2. Start the latest official release of Superset
|
|
|
|
```bash
|
|
# Enter the repository you just cloned
|
|
$ cd superset
|
|
|
|
# Set the repo to the state associated with the latest official version
|
|
$ git checkout tags/6.0.0
|
|
|
|
# Fire up Superset using Docker Compose
|
|
$ docker compose -f docker-compose-image-tag.yml up
|
|
```
|
|
|
|
This may take a moment as Docker Compose will fetch the underlying
|
|
container images and will load up some examples. Once all containers
|
|
are downloaded and the output settles, you're ready to log in.
|
|
|
|
⚠️ If you get an error message like `validating superset\docker-compose-image-tag.yml: services.superset-worker-beat.env_file.0 must be a string`, you need to update your version of `docker-compose`.
|
|
Note that `docker-compose` is on the path to deprecation and you should now use `docker compose` instead.
|
|
|
|
### 3. Log into Superset
|
|
|
|
Now head over to [http://localhost:8088](http://localhost:8088) and log in with the default created account:
|
|
|
|
```bash
|
|
username: admin
|
|
password: admin
|
|
```
|
|
|
|
#### 🎉 Congratulations! Superset is now up and running on your machine! 🎉
|
|
|
|
### Wrapping Up
|
|
|
|
Once you're done with Superset, you can stop and delete just like any other container environment:
|
|
|
|
```bash
|
|
docker compose down
|
|
```
|
|
|
|
:::tip
|
|
You can use the same environment more than once, as Superset will persist data locally. However, make sure to properly stop all
|
|
processes by running Docker Compose `stop` command. By doing so, you can avoid data corruption and/or loss of data.
|
|
:::
|
|
|
|
## What's next?
|
|
|
|
From this point on, you can head on to:
|
|
|
|
- [Create your first Dashboard](/user-docs/6.0.0/using-superset/creating-your-first-dashboard)
|
|
- [Connect to a Database](/user-docs/6.0.0/configuration/databases)
|
|
- [Using Docker Compose](/user-docs/6.0.0/installation/docker-compose)
|
|
- [Configure Superset](/user-docs/6.0.0/configuration/configuring-superset/)
|
|
- [Installing on Kubernetes](/user-docs/6.0.0/installation/kubernetes/)
|
|
|
|
Or just explore our [Documentation](https://superset.apache.org/docs/intro)!
|