mirror of
https://github.com/apache/superset.git
synced 2026-05-23 16:55:19 +00:00
4266d36cf4
Snapshots all four versioned Docusaurus sections at v6.1.0, cut from master after the version-cutting tooling (#39837) and broken-internal- links fixes (#40102) landed. Captures fresh auto-generated content and freezes data dependencies so the historical snapshot stays correct. Versioning behavior: lastVersion stays at current for every section, so the canonical URLs (/docs/..., /admin-docs/..., /developer-docs/..., /components/...) continue to render content from master. The current version is consistently labeled "Next" with an unreleased banner, and 6.1.0 is a historical pin accessible only via its explicit version segment. Component playground: previously disabled: true in versions-config.json, now enabled and versioned. The plugin block in docusaurus.config.ts was already gated only by the disabled flag, so no other code changes were needed to bring it back online. Snapshot includes: - All MDX content for the four sections. - Auto-gen captured fresh: 74 database pages (engine spec metadata), ~1,800 API reference files (openapi.json), 59 component pages (Storybook stories). - Data imports frozen at cut time into snapshot-local _versioned_data/ dirs: versioned_docs/version-6.1.0/_versioned_data/src/data/databases.json (canonical 80-database diagnostics from master, preserved by the generator's input-hash cache) admin_docs_versioned_docs/version-6.1.0/_versioned_data/data/countries.json admin_docs_versioned_docs/version-6.1.0/_versioned_data/static/feature-flags.json developer_docs_versioned_docs/version-6.1.0/_versioned_data/static/data/components.json - Import paths in deeply-nested files rewritten so they still resolve from one directory deeper inside the snapshot. Verified via full yarn build: exit 0, no broken links surfaced by onBrokenLinks: throw. Anchor warnings present are pre-existing on master (community#superset-community-calendar) and unrelated.
89 lines
2.9 KiB
Plaintext
89 lines
2.9 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](/admin-docs/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/using-superset/creating-your-first-dashboard)
|
|
- [Connect to a Database](/user-docs/databases/)
|
|
- [Using Docker Compose](/admin-docs/installation/docker-compose)
|
|
- [Configure Superset](/admin-docs/configuration/configuring-superset)
|
|
- [Installing on Kubernetes](/admin-docs/installation/kubernetes)
|
|
|
|
Or just explore our [Documentation](https://superset.apache.org/docs/intro)!
|
|
|
|
:::resources
|
|
- [Video: Superset in 2 Minutes](https://www.youtube.com/watch?v=AqousXQ7YHw)
|
|
- [Video: Superset 101](https://www.youtube.com/watch?v=mAIH3hUoxEE)
|
|
- [Tutorial: Creating Your First Dashboard](/user-docs/using-superset/creating-your-first-dashboard)
|
|
:::
|