"use strict";(self.webpackChunkdashy=self.webpackChunkdashy||[]).push([[239],{3905:function(e,t,n){n.d(t,{Zo:function(){return u},kt:function(){return d}});var a=n(7294);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 r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?r(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):r(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,a,o=function(e,t){if(null==e)return{};var n,a,o={},r=Object.keys(e);for(a=0;a<r.length;a++)n=r[a],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a<r.length;a++)n=r[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},u=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),h=p(n),d=o,m=h["".concat(s,".").concat(d)]||h[d]||c[d]||r;return n?a.createElement(m,i(i({ref:t},u),{},{components:n})):a.createElement(m,i({ref:t},u))}));function d(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=h;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:o,i[1]=l;for(var p=2;p<r;p++)i[p]=n[p];return a.createElement.apply(null,i)}return a.createElement.apply(null,n)}h.displayName="MDXCreateElement"},8615:function(e,t,n){n.r(t),n.d(t,{frontMatter:function(){return l},contentTitle:function(){return s},metadata:function(){return p},toc:function(){return u},default:function(){return h}});var a=n(7462),o=n(3366),r=(n(7294),n(3905)),i=["components"],l={},s="Quick Start",p={unversionedId:"quick-start",id:"quick-start",isDocsHomePage:!1,title:"Quick Start",description:"Welcome to Dashy! So glad you're here \ud83d\ude0a In a couple of minutes, you'll have your new dashboard up and running \ud83d\ude80",source:"@site/docs/quick-start.md",sourceDirName:".",slug:"/quick-start",permalink:"/docs/quick-start",editUrl:"https://github.com/Lissy93/dashy/edit/gh-pages/docs/docs/quick-start.md",version:"current",frontMatter:{},sidebar:"dashySidebar",next:{title:"Deployment",permalink:"/docs/deployment"}},u=[{value:"1. Prerequisites",id:"1-prerequisites",children:[]},{value:"2. Installation",id:"2-installation",children:[]},{value:"3. Configure",id:"3-configure",children:[]},{value:"4. Further Customisation",id:"4-further-customisation",children:[]},{value:"5. Final Note",id:"5-final-note",children:[]},{value:"Alternative Deployment Method 1 - From Source",id:"alternative-deployment-method-1---from-source",children:[]},{value:"Alternative Deployment Method 2 - Netlify",id:"alternative-deployment-method-2---netlify",children:[]},{value:"Alternative Deployment Method 3 - Cloud Services",id:"alternative-deployment-method-3---cloud-services",children:[]}],c={toc:u};function h(e){var t=e.components,n=(0,o.Z)(e,i);return(0,r.kt)("wrapper",(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"quick-start"},"Quick Start"),(0,r.kt)("p",null,"Welcome to Dashy! So glad you're here \ud83d\ude0a In a couple of minutes, you'll have your new dashboard up and running \ud83d\ude80"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"TDLR;")," Run ",(0,r.kt)("inlineCode",{parentName:"p"},"docker run -p 8080:80 lissy93/dashy"),", then open ",(0,r.kt)("inlineCode",{parentName:"p"},"http://localhost:8080")),(0,r.kt)("hr",null),(0,r.kt)("h2",{id:"1-prerequisites"},"1. Prerequisites"),(0,r.kt)("p",null,"The quickest and easiest method of running Dashy is using Docker (or another container engine). You can find installation instructions for your system in the ",(0,r.kt)("a",{parentName:"p",href:"https://docs.docker.com/get-docker/"},"Docker Documentation"),".\nIf you don't want to use Docker, then you can use one of Dashy's other supported installation methods instead, all of which are outlined in the ",(0,r.kt)("a",{parentName:"p",href:"/docs/deployment"},"Deployment Docs"),"."),(0,r.kt)("hr",null),(0,r.kt)("h2",{id:"2-installation"},"2. Installation"),(0,r.kt)("p",null,"To pull the latest image, and build and start the app run:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"docker run -d \\\n  -p 8080:80 \\\n  -v ~/my-conf.yml:/app/public/conf.yml \\\n  --name my-dashboard \\\n  --restart=always \\\n  lissy93/dashy:latest\n")),(0,r.kt)("p",null,"Either replace the -v path to point to your config file, or leave it out. For a full list of available options, then see ",(0,r.kt)("a",{parentName:"p",href:"/docs/deployment#deploy-with-docker"},"Dashy with Docker")," Docs. If you'd prefer to use Docker Compose, then see ",(0,r.kt)("a",{parentName:"p",href:"/docs/deployment#using-docker-compose"},"Dashy with Docker Compose")," Docs. Alternate registries, architectures and pinned versions are also supported."),(0,r.kt)("p",null,"Your dashboard should now be up and running at ",(0,r.kt)("inlineCode",{parentName:"p"},"http://localhost:8080")," (or your servers IP address/ domain, and the port that you chose). The first time you build, it may take a few minutes."),(0,r.kt)("hr",null),(0,r.kt)("h2",{id:"3-configure"},"3. Configure"),(0,r.kt)("p",null,"Now that you've got Dashy running, you are going to want to set it up with your own content.\nConfig is written in ",(0,r.kt)("a",{parentName:"p",href:"https://yaml.org/"},"YAML Format"),", and saved in ",(0,r.kt)("a",{parentName:"p",href:"/public/conf.yml"},(0,r.kt)("inlineCode",{parentName:"a"},"/public/conf.yml")),".\nThe format on the config file is pretty straight forward. There are three root attributes:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/configuring#pageinfo"},(0,r.kt)("inlineCode",{parentName:"a"},"pageInfo"))," - Dashboard meta data, like title, description, nav bar links and footer text"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/configuring#appconfig-optional"},(0,r.kt)("inlineCode",{parentName:"a"},"appConfig"))," - Dashboard settings, like themes, authentication, language and customization"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/configuring#section"},(0,r.kt)("inlineCode",{parentName:"a"},"sections"))," - An array of sections, each including an array of items")),(0,r.kt)("p",null,"You can view a full list of all available config options in the ",(0,r.kt)("a",{parentName:"p",href:"/docs/configuring"},"Configuring Docs"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"pageInfo:\n  title: Home Lab\nsections: # An array of sections\n- name: Example Section\n  icon: far fa-rocket\n  items:\n  - title: GitHub\n    description: Dashy source code and docs\n    icon: fab fa-github\n    url: https://github.com/Lissy93/dashy\n  - title: Issues\n    description: View open issues, or raise a new one\n    icon: fas fa-bug\n    url: https://github.com/Lissy93/dashy/issues\n- name: Local Services\n  items:\n  - title: Firewall\n    icon: favicon\n    url: http://192.168.1.1/\n  - title: Game Server\n    icon: https://i.ibb.co/710B3Yc/space-invader-x256.png\n    url: http://192.168.130.1/\n")),(0,r.kt)("p",null,"Notes:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"You can use a Docker volume to pass a config file from your host system to the container",(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"E.g. ",(0,r.kt)("inlineCode",{parentName:"li"},"-v ./host-system/my-local-conf.yml:/app/public/conf.yml")))),(0,r.kt)("li",{parentName:"ul"},"It's also possible to edit your config directly through the UI, and changes will be saved in this file"),(0,r.kt)("li",{parentName:"ul"},"Check your config against Dashy's schema, with ",(0,r.kt)("inlineCode",{parentName:"li"},"docker exec -it [container-id] yarn validate-config")),(0,r.kt)("li",{parentName:"ul"},"You might find it helpful to look at some examples, a collection of which can be ",(0,r.kt)("a",{parentName:"li",href:"https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10"},"found here")),(0,r.kt)("li",{parentName:"ul"},"After editing your config, the app will rebuild in the background, which may take a minute")),(0,r.kt)("hr",null),(0,r.kt)("h2",{id:"4-further-customisation"},"4. Further Customisation"),(0,r.kt)("p",null,"Once you've got Dashy setup, you'll want to ensure the container is properly healthy, secured, backed up and kept up-to-date. All this is covered in the ",(0,r.kt)("a",{parentName:"p",href:"/docs/management"},"Management Docs"),"."),(0,r.kt)("p",null,"You might also want to check out the docs for specific features you'd like to use:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/authentication"},"Authentication")," - Setting up authentication to protect your dashboard"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/alternate-views"},"Alternate Views")," - Using the startpage and workspace view"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/backup-restore"},"Backup & Restore")," - Guide to Dashy's cloud sync feature"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/icons"},"Icons")," - Outline of all available icon types for sections and items"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/multi-language-support"},"Localisation")," - How to change language, or add your own"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/status-indicators"},"Status Indicators")," - Using Dashy to monitor uptime and status of your apps"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/searching"},"Search & Shortcuts")," - Using instant filter, web search and custom hotkeys"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/theming"},"Theming")," - Complete guide to applying, writing and modifying themes and styles")),(0,r.kt)("hr",null),(0,r.kt)("h2",{id:"5-final-note"},"5. Final Note"),(0,r.kt)("p",null,"If you're enjoying Dashy, and have a few minutes to spare, please do take a moment to look at the ",(0,r.kt)("a",{parentName:"p",href:"/docs/contributing"},"Contributing Page"),". There are a few things that we really need some help with, and whatever your skill set, there are ways you can help out. Any contributions, however small would be greatly appreciated.\nThank you to ",(0,r.kt)("a",{parentName:"p",href:"/docs/credits"},"everyone")," who is already doing so, without developing and maintaining Dashy would not have been so possible."),(0,r.kt)("p",null,"You can also consider sharing your dashboard in the ",(0,r.kt)("a",{parentName:"p",href:"/docs/showcase"},"Showcase"),", to help provide inspiration for others."),(0,r.kt)("p",null,"If you're enjoying Dashy, and have a few minutes to spare, please do take a moment to look at the ",(0,r.kt)("a",{parentName:"p",href:"/docs/contributing"},"Contributing Page"),". Huge thanks to ",(0,r.kt)("a",{parentName:"p",href:"/docs/credits"},"everyone")," who has already helped out!"),(0,r.kt)("p",null,"Enjoy your dashboard :) "),(0,r.kt)("hr",null),(0,r.kt)("h2",{id:"alternative-deployment-method-1---from-source"},"Alternative Deployment Method 1 - From Source"),(0,r.kt)("p",null,"You can also easily run the app on your system without Docker. For this ",(0,r.kt)("a",{parentName:"p",href:"https://git-scm.com/downloads"},"Git"),", ",(0,r.kt)("a",{parentName:"p",href:"https://nodejs.org/"},"Node.js"),", and ",(0,r.kt)("a",{parentName:"p",href:"https://yarnpkg.com/"},"Yarn")," are required."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"git clone https://github.com/Lissy93/dashy.git && cd dashy\nyarn # Install dependencies\nyarn build # Build the app\nyarn start # Start the app\n")),(0,r.kt)("p",null,"Then edit ",(0,r.kt)("inlineCode",{parentName:"p"},"./public/conf.yml")," and rebuild the app with ",(0,r.kt)("inlineCode",{parentName:"p"},"yarn build")),(0,r.kt)("hr",null),(0,r.kt)("h2",{id:"alternative-deployment-method-2---netlify"},"Alternative Deployment Method 2 - Netlify"),(0,r.kt)("p",null,"Don't have a server? No problem! You can run Dashy for free on Netlify (as well as many ",(0,r.kt)("a",{parentName:"p",href:"/docs/deployment#deploy-to-cloud-service"},"other cloud providers"),"). All you need it a GitHub account."),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},"Fork Dashy's repository on GitHub"),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("a",{parentName:"li",href:"app.netlify.com/login/"},"Log in")," to Netlify with GitHub"),(0,r.kt)("li",{parentName:"ol"},'Click "New site from Git" and select your forked repo, then click ',(0,r.kt)("strong",{parentName:"li"},"Deploy"),"!"),(0,r.kt)("li",{parentName:"ol"},"You can then edit the config in ",(0,r.kt)("inlineCode",{parentName:"li"},"./public/conf.yml")," in your repo, and Netlify will rebuild the app")),(0,r.kt)("hr",null),(0,r.kt)("h2",{id:"alternative-deployment-method-3---cloud-services"},"Alternative Deployment Method 3 - Cloud Services"),(0,r.kt)("p",null,"Dashy supports 1-Click deployments on several popular cloud platforms. To spin up a new instance, just click a link below:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy"},(0,r.kt)("img",{src:"https://i.ibb.co/ZxtzrP3/netlify.png",width:"18"})," Deploy to Netlify")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://heroku.com/deploy?template=https://github.com/Lissy93/dashy"},(0,r.kt)("img",{src:"https://i.ibb.co/d2P1WZ7/heroku.png",width:"18"})," Deploy to Heroku")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://vercel.com/new/project?template=https://github.com/lissy93/dashy"},(0,r.kt)("img",{src:"https://i.ibb.co/Ld2FZzb/vercel.png",width:"18"})," Deploy to Vercel")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://render.com/deploy?repo=https://github.com/lissy93/dashy/tree/deploy_render"},(0,r.kt)("img",{src:"https://i.ibb.co/xCHtzgh/render.png",width:"18"})," Deploy to Render")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://deploy.cloud.run/?git_repo=https://github.com/lissy93/dashy.git"},(0,r.kt)("img",{src:"https://i.ibb.co/J7MGymY/googlecloud.png",width:"18"})," Deploy to GCP")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml"},(0,r.kt)("img",{src:"https://i.ibb.co/HVWVYF7/docker.png",width:"18"})," Deploy to PWD"))))}h.isMDXComponent=!0}}]);