Skip to main content
Edit this page on GitHub

Quickstart

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, Docker Compose, and Git 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 page.

1. Get Superset​

$ git clone https://github.com/apache/superset

2. Start the latest official release of Superset​

# Enter the repository you just cloned
$ cd superset

# 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 and log in with the default created account:

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:

$ 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:

Or just explore our Documentation!