| "use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[6505],{15680:(e,t,r)=>{r.d(t,{xA:()=>l,yg:()=>y});var n=r(96540);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function s(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),u=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=u(e.components);return n.createElement(p.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},g=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),c=u(r),g=a,y=c["".concat(p,".").concat(g)]||c[g]||d[g]||o;return r?n.createElement(y,i(i({ref:t},l),{},{components:r})):n.createElement(y,i({ref:t},l))}));function y(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);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:a,i[1]=s;for(var u=2;u<o;u++)i[u]=r[u];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}g.displayName="MDXCreateElement"},92827:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>u});var n=r(58168),a=(r(96540),r(15680));const o={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 will help you run Superset on your local machine in",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={},u=[{value:"1. Get Superset",id:"1-get-superset",level:3},{value:"2. Start Superset",id:"2-start-superset",level:3},{value:"3. Create an account",id:"3-create-an-account",level:3},{value:"4. Configure Superset",id:"4-configure-superset",level:3},{value:"5. Start using Superset",id:"5-start-using-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's next?",id:"whats-next",level:2}],l={toc:u},c="wrapper";function d(e){let{components:t,...r}=e;return(0,a.yg)(c,(0,n.A)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.yg)("p",null,(0,a.yg)("strong",{parentName:"p"},"Ready to give Apache Superset a try?")," This quickstart will help you run Superset on your local machine in\n",(0,a.yg)("strong",{parentName:"p"},"5 simple steps"),". It assumes that you have ",(0,a.yg)("a",{parentName:"p",href:"https://www.docker.com"},"Docker")," installed."),(0,a.yg)("h3",{id:"1-get-superset"},"1. Get Superset"),(0,a.yg)("p",null,"To get started, set the ",(0,a.yg)("inlineCode",{parentName:"p"},"SUPERSET_VERSION")," environment variable with the latest Superset version.\n",(0,a.yg)("a",{parentName:"p",href:"https://github.com/apache/superset/releases"},"Click here")," to check the latest version."),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},"$ export SUPERSET_VERSION=<latest_version>\n")),(0,a.yg)("p",null,"Pull the Superset image from Docker Hub:"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},"$ docker pull apache/superset:$SUPERSET_VERSION\n")),(0,a.yg)("h3",{id:"2-start-superset"},"2. Start Superset"),(0,a.yg)("admonition",{type:"tip"},(0,a.yg)("p",{parentName:"admonition"},"Note that some configuration is mandatory for Superset in order to start. In particular, Superset will not start without\na user-specified value of ",(0,a.yg)("inlineCode",{parentName:"p"},"SECRET_KEY")," in a Superset configuration file or ",(0,a.yg)("inlineCode",{parentName:"p"},"SUPERSET_SECRET_KEY")," as an environment variable.\nPlease see ",(0,a.yg)("a",{parentName:"p",href:"/docs/installation/configuring-superset/"},"Configuring Superset")," for more details.")),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},'$ docker run -d -p 8080:8088 \\\n -e "SUPERSET_SECRET_KEY=$(openssl rand -base64 42)" \\\n -e "TALISMAN_ENABLED=False" \\\n --name superset apache/superset:$SUPERSET_VERSION\n')),(0,a.yg)("h3",{id:"3-create-an-account"},"3. Create an account"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},"$ docker exec -it superset superset fab create-admin \\\n --username admin \\\n --firstname Admin \\\n --lastname Admin \\\n --email admin@localhost \\\n --password admin\n")),(0,a.yg)("h3",{id:"4-configure-superset"},"4. Configure Superset"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},"$ docker exec -it superset superset db upgrade &&\n docker exec -it superset superset load_examples &&\n docker exec -it superset superset init\n")),(0,a.yg)("admonition",{type:"tip"},(0,a.yg)("p",{parentName:"admonition"},"This step can take some time. While you wait, feel free to join the official Slack channel to check for new releases,\nask questions, and engage with the community.\n",(0,a.yg)("a",{parentName:"p",href:"http://bit.ly/join-superset-slack"},"Click here to join."))),(0,a.yg)("h3",{id:"5-start-using-superset"},"5. Start using Superset"),(0,a.yg)("p",null,"After configuring your fresh instance, head over to ",(0,a.yg)("a",{parentName:"p",href:"http://localhost:8080"},"http://localhost:8080")," and\nlog in with the default created account:"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},"username: admin\npassword: admin\n")),(0,a.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,a.yg)("h3",{id:"wrapping-up"},"Wrapping Up"),(0,a.yg)("p",null,"Once you're done with Superset, you can stop and remove it just like any other container:"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},"$ docker container rm -f superset\n")),(0,a.yg)("admonition",{type:"tip"},(0,a.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,a.yg)("inlineCode",{parentName:"p"},"stop")," command. By doing so, you can avoid data corruption and/or loss of data.")),(0,a.yg)("h2",{id:"whats-next"},"What's next?"),(0,a.yg)("p",null,"From this point on, you can head on to:"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("a",{parentName:"li",href:"/docs/creating-charts-dashboards/creating-your-first-dashboard"},"Create your first Dashboard")),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("a",{parentName:"li",href:"/docs/databases/installing-database-drivers"},"Connect to a Database")),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("a",{parentName:"li",href:"/docs/installation/configuring-superset/"},"Configure Superset"))),(0,a.yg)("p",null,"Or just explore our Documentation!"))}d.isMDXComponent=!0}}]); |