"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[6505],{15680:(e,t,n)=>{n.d(t,{xA:()=>u,yg:()=>m});var r=n(96540);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?a(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):a(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},a=Object.keys(e);for(r=0;r<a.length;r++)n=a[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r<a.length;r++)n=a[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},g=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,p=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),c=l(n),g=o,m=c["".concat(p,".").concat(g)]||c[g]||d[g]||a;return n?r.createElement(m,i(i({ref:t},u),{},{components:n})):r.createElement(m,i({ref:t},u))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=g;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[c]="string"==typeof e?e:o,i[1]=s;for(var l=2;l<a;l++)i[l]=n[l];return r.createElement.apply(null,i)}return r.createElement.apply(null,n)}g.displayName="MDXCreateElement"},92827:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>s,toc:()=>l});var r=n(58168),o=(n(96540),n(15680));const a={title:"Quickstart",hide_title:!1,sidebar_position:2},i=void 0,s={unversionedId:"quickstart",id:"quickstart",title:"Quickstart",description:"Ready to give Apache Superset a try? This quickstart guide will help you",source:"@site/docs/quickstart.mdx",sourceDirName:".",slug:"/quickstart",permalink:"/docs/quickstart",draft:!1,editUrl:"https://github.com/apache/superset/edit/master/docs/docs/quickstart.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{title:"Quickstart",hide_title:!1,sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/intro"},next:{title:"Installing on Kubernetes",permalink:"/docs/installation/running-on-kubernetes"}},p={},l=[{value:"1. Get Superset",id:"1-get-superset",level:3},{value:"2. Start the latest official release of Superset",id:"2-start-the-latest-official-release-of-superset",level:3},{value:"3. Log into Superset",id:"3-log-into-superset",level:3},{value:"\ud83c\udf89 Congratulations! Superset is now up and running on your machine! \ud83c\udf89",id:"-congratulations-superset-is-now-up-and-running-on-your-machine-",level:4},{value:"Wrapping Up",id:"wrapping-up",level:3},{value:"What&#39;s next?",id:"whats-next",level:2}],u={toc:l},c="wrapper";function d(e){let{components:t,...n}=e;return(0,o.yg)(c,(0,r.A)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,o.yg)("p",null,(0,o.yg)("strong",{parentName:"p"},"Ready to give Apache Superset a try?")," This quickstart guide will help you\nget up and running on your local machine in ",(0,o.yg)("strong",{parentName:"p"},"3 simple steps"),". Note that\nit assumes that you have ",(0,o.yg)("a",{parentName:"p",href:"https://www.docker.com"},"Docker"),",\n",(0,o.yg)("a",{parentName:"p",href:"https://docs.docker.com/compose/"},"docker-compose"),", and\n",(0,o.yg)("a",{parentName:"p",href:"https://git-scm.com/"},"git")," installed."),(0,o.yg)("admonition",{type:"caution"},(0,o.yg)("p",{parentName:"admonition"},"While we recommend using ",(0,o.yg)("inlineCode",{parentName:"p"},"docker-compose")," for a quick start in a sandbox-type\nenvironment and for other development-type use cases, ",(0,o.yg)("strong",{parentName:"p"},"we\ndo not recommend this setup for production"),". For this purpose please\nrefer to our\n",(0,o.yg)("a",{parentName:"p",href:"/docs/installation/running-on-kubernetes/"},"Installing on Kubernetes"),"\npage.")),(0,o.yg)("h3",{id:"1-get-superset"},"1. Get Superset"),(0,o.yg)("pre",null,(0,o.yg)("code",{parentName:"pre",className:"language-bash"},"$ git clone https://github.com/apache/superset\n")),(0,o.yg)("h3",{id:"2-start-the-latest-official-release-of-superset"},"2. Start the latest official release of Superset"),(0,o.yg)("pre",null,(0,o.yg)("code",{parentName:"pre"},"# Enter the repository you just cloned\n$ cd superset\n\n# Fire up Superset using docker-compose\n$ docker-compose -f docker-compose-image-tag.yml up\n")),(0,o.yg)("p",null,"This may take a moment as docker-compose will fetch the underlying\ndocker images and will load up some examples. Once all containers\nare downloaded and the output settles, you're ready to log in."),(0,o.yg)("h3",{id:"3-log-into-superset"},"3. Log into Superset"),(0,o.yg)("p",null,"Now head over to ",(0,o.yg)("a",{parentName:"p",href:"http://localhost:8088"},"http://localhost:8088")," and log in with the default created account:"),(0,o.yg)("pre",null,(0,o.yg)("code",{parentName:"pre"},"username: admin\npassword: admin\n")),(0,o.yg)("h4",{id:"-congratulations-superset-is-now-up-and-running-on-your-machine-"},"\ud83c\udf89 Congratulations! Superset is now up and running on your machine! \ud83c\udf89"),(0,o.yg)("h3",{id:"wrapping-up"},"Wrapping Up"),(0,o.yg)("p",null,"Once you're done with Superset, you can stop and remove it just like any other container:"),(0,o.yg)("pre",null,(0,o.yg)("code",{parentName:"pre"},"$ docker-compose down\n")),(0,o.yg)("admonition",{type:"tip"},(0,o.yg)("p",{parentName:"admonition"},"You can use the same container more than once, as Superset will persist data locally. However, make sure to properly stop all\nprocesses by running Docker ",(0,o.yg)("inlineCode",{parentName:"p"},"stop")," command. By doing so, you can avoid data corruption and/or loss of data.")),(0,o.yg)("h2",{id:"whats-next"},"What's next?"),(0,o.yg)("p",null,"From this point on, you can head on to:"),(0,o.yg)("ul",null,(0,o.yg)("li",{parentName:"ul"},(0,o.yg)("a",{parentName:"li",href:"/docs/creating-charts-dashboards/creating-your-first-dashboard"},"Create your first Dashboard")),(0,o.yg)("li",{parentName:"ul"},(0,o.yg)("a",{parentName:"li",href:"/docs/databases/installing-database-drivers"},"Connect to a Database")),(0,o.yg)("li",{parentName:"ul"},(0,o.yg)("a",{parentName:"li",href:"/docs/installation/installing-superset-using-docker-compose"},"Using Docker Compose"),": find\nout more about how to install docker & docker-compose, how to point to different Superset\nversion, or how to set up your development environment."),(0,o.yg)("li",{parentName:"ul"},(0,o.yg)("a",{parentName:"li",href:"/docs/installation/configuring-superset/"},"Configure Superset"),": Superset is highly configurable.\nFind out what the options are here."),(0,o.yg)("li",{parentName:"ul"},(0,o.yg)("a",{parentName:"li",href:"/docs/installation/running-on-kubernetes/"},"Installing on Kubernetes"),": if you'd like to setup\nSuperset in a production environment, we recommend using ",(0,o.yg)("a",{parentName:"li",href:"https://kubernetes.io/"},"Kubernetes"),"\nand our official ",(0,o.yg)("a",{parentName:"li",href:"https://github.com/apache/superset/tree/master/helm/superset"},"Helm Chart"),".")),(0,o.yg)("p",null,"Or just explore our ",(0,o.yg)("a",{parentName:"p",href:"https://superset.apache.org/docs/intro"},"Documentation"),"!"))}d.isMDXComponent=!0}}]);