https://psappdeploytoolkit.com/assets/js/972d9d57.f7f2c656.js

1"use strict";(self.webpackChunkpsappdeploytoolkit_website=self.webpackChunkpsappdeploytoolkit_website||[]).push([["26223"],{55565(e,n,o){o.r(n),o.d(n,{metadata:()=>t,default:()=>h,frontMatter:()=>r,contentTitle:()=>l,toc:()=>d,assets:()=>a});var t=JSON.parse('{"id":"introduction","title":"Introduction","description":"Get up and running with PSAppDeployToolkit in minutes.","source":"@site/docs/introduction.mdx","sourceDirName":".","slug":"/introduction","permalink":"/docs/introduction","draft":false,"unlisted":false,"tags":[{"inline":true,"label":"Documentation","permalink":"/docs/tags/documentation"},{"inline":true,"label":"Introduction","permalink":"/docs/tags/introduction"}],"version":"current","sidebarPosition":1,"frontMatter":{"sidebar_position":1,"title":"Introduction","description":"Get up and running with PSAppDeployToolkit in minutes.","hide_title":true,"id":"introduction","tags":["Documentation","Introduction"]},"sidebar":"documentation","next":{"title":"Tutorials","permalink":"/docs/category/tutorials"}}'),i=o(91987),s=o(67008);let r={sidebar_position:1,title:"Introduction",description:"Get up and running with PSAppDeployToolkit in minutes.",hide_title:!0,id:"introduction",tags:["Documentation","Introduction"]},l,a={},d=[{value:"What is PSAppDeployToolkit?",id:"what-is-psappdeploytoolkit",level:2},{value:"Finding your way around",id:"finding-your-way-around",level:2},{value:"Getting Help / Support",id:"getting-help--support",level:2},{value:"Reporting Issues",id:"reporting-issues",level:2},{value:"Open-source & Contributing",id:"open-source--contributing",level:2},{value:"Something missing? Typos?",id:"something-missing-typos",level:2}];function c(e){let n={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",li:"li",p:"p",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"what-is-psappdeploytoolkit",children:"What is PSAppDeployToolkit?"}),"\n",(0,i.jsxs)(n.p,{children:["A ",(0,i.jsx)(n.em,{children:"PowerShell"})," based framework, to ",(0,i.jsx)(n.strong,{children:"simplify and standardize"})," the process of ",(0,i.jsx)(n.strong,{children:"deploying software"})," to ",(0,i.jsx)(n.strong,{children:"Windows"})," based computers, ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.em,{children:"at scale"})}),"."]}),"\n",(0,i.jsx)(n.p,{children:"It is typically used to wrap an existing vendor-supplied installer package (e.g. source files containing an MSI or EXE file), and to extend it's functionality using:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["A standardized, battle-tested ",(0,i.jsx)(n.strong,{children:"workflow"})," for every application install, uninstall and repair."]}),"\n",(0,i.jsxs)(n.li,{children:["A highly-customizable ",(0,i.jsx)(n.strong,{children:"User Interface"})," that remains consistent for end users, for every deployment."]}),"\n",(0,i.jsxs)(n.li,{children:["An extensive ",(0,i.jsx)(n.strong,{children:"library of functions"})," to simplify common deployment tasks."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["... which results in a ",(0,i.jsx)(n.strong,{children:"consistent and brandable user experience"})," and ",(0,i.jsx)(n.strong,{children:"highly successful deployments"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"finding-your-way-around",children:"Finding your way around"}),"\n",(0,i.jsx)(n.p,{children:"This documentation is organized by what you are trying to do."}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"/docs/tutorials/your-first-deployment",children:"Tutorials"})})," are the place to start if you are new. They\nare lessons to work through, and each one ends with something working on your machine."]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/tutorials/your-first-deployment",children:"Your first deployment"})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/tutorials/adding-a-user-experience",children:"Adding a user experience"})}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"/docs/how-to/install-the-toolkit",children:"How-to guides"})})," are recipes for specific goals, for when you\nalready know what you want to achieve."]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/how-to/install-the-toolkit",children:"Install the toolkit"})," and\n",(0,i.jsx)(n.a,{href:"/docs/how-to/create-a-deployment",children:"create a deployment"})]}),"\n",(0,i.jsxs)(n.li,{children:["Deploy with ",(0,i.jsx)(n.a,{href:"/docs/how-to/deploy-with-intune",children:"Intune"})," or\n",(0,i.jsx)(n.a,{href:"/docs/how-to/deploy-with-configmgr",children:"Configuration Manager"})]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/how-to/upgrade-from-v3",children:"Upgrade from v3.x"}

1)," or\n",(0,i.jsx)(n.a,{href:"/docs/how-to/upgrade-from-v4-0",children:"from v4.0"})]}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/docs/how-to/troubleshoot-a-deployment",children:"Troubleshoot a deployment"})}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"/docs/explanation/architecture",children:"Explanation"})})," covers background and reasoning, for when you want\nto understand why the toolkit behaves the way it does."]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/explanation/architecture",children:"Architecture"})," and\n",(0,i.jsx)(n.a,{href:"/docs/explanation/the-deployment-script",children:"the deployment script"})]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/explanation/deployment-modes",children:"Deployment modes"}),", or why your dialogs did or did not appear"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/explanation/configuration",children:"Configuration"}),", ",(0,i.jsx)(n.a,{href:"/docs/explanation/logging",children:"logging"})," and\n",(0,i.jsx)(n.a,{href:"/docs/explanation/user-interface",children:"the user interface"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.a,{href:"/docs/reference",children:"Reference"})})," is the precise technical description, for looking things up."]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"./category/functions",children:"Every function"}),", with parameters and examples"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/adtsession-object",children:"ADTSession properties"}),",\n",(0,i.jsx)(n.a,{href:"/docs/reference/variables",children:"variables"}),", ",(0,i.jsx)(n.a,{href:"/docs/reference/config-settings",children:"settings"})," and\n",(0,i.jsx)(n.a,{href:"/docs/reference/exit-codes",children:"exit codes"})]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/reference/troubleshooting",children:"Troubleshooting"})," and ",(0,i.jsx)(n.a,{href:"/docs/reference/faq",children:"FAQ"})]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"getting-help--support",children:"Getting Help / Support"}),"\n",(0,i.jsx)(n.p,{children:"PSAppDeployToolkit is open-source software and provided free for anyone to use. The development team provide support on a best-effort basis. In our experience, most questions can be answered by searching the documentation or the community platforms for an answer."}),"\n",(0,i.jsx)(n.admonition,{title:"Enterprise Support",type:"info",children:(0,i.jsxs)(n.p,{children:["We recognize that some enterprises face adoption challenges due to audit requirements for vendor support. Patch My PC are stewards of the PSADT Project and, as experts in open-source deployment, are uniquely positioned to offer both deep technical knowledge and enterprise-level support - allowing customers to fully benefit from open-source tools without compromise. ",(0,i.jsx)(n.a,{href:"https://patchmypc.com/product/psadt",children:"Learn more about Patch My PC's support for PSADT"}),"."]})}),"\n",(0,i.jsx)(n.h2,{id:"reporting-issues",children:"Reporting Issues"}),"\n",(0,i.jsx)(n.p,{children:"Failing that, we have a great community of users and contributors who are often happy to help answer questions, share their knowledge and experience, and even contribute code to the project. They are:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"https://github.com/psappdeploytoolkit/psappdeploytoolkit",children:"GitHub Repository"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Best place for reporting issues or to get stuck into the code."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"https://discourse.psappdeploytoolkit.com",children:"Discourse Forum"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Great repository of knowledge, with an active helpful community."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"https://discord.com/channels/618712310185197588/627204361545842688",children:"WinAdmins Discord"})," ",(0,i.jsx)(n.strong,{children:"#psappdeploytoolkit"})," channel","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Great for realtime help with issues or quick questions answered by our helpful community members and the dev team."}),"\n",(0,i.jsx)(n.li,{children:"We typically share news and updates about upcoming releases and sometimes ask for help with beta testing, so it's a good place to stay up to date with the project."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"open-source--contributing",children:"Open-source & Contributing"}),"\n",(0,i.jsxs)(n.p,{children:["PSAppDeployToolkit is an open-source project (see ",(0,i.jsx)(n.a,{href:"https://github.com/psappdeploytoolkit/psappdeploytoolkit/blob/master/COPYING.Lesser",children:(0,i.jsx)(n.code,{children:"COPYING.Lesser"})})," file for more information). The core project, as well as the documentation and any related tools can be found in the ",(0,i.jsx)(n.a,{href:"https://github.com/psappdeploytoolkit",children:"PSAppDeployToolkit"})," GitHub organization."]}),"\n",(0,i.jsx)(n.p,{children:"PSAppDeployToolkit is open to code contributions, including feature requests, bug reports, and pull requests."}),"\n",(0,i.jsx)(n.h2,{id:"something-missing-typos",children:"Something missing? Typos?"}),"\n",(0,i.jsxs)(n.p,{children:["If you find issues with the documentation or have ideas for improvements, please ",(0,i.jsx)(n.a,{href:"https://github.com/PSAppDeployToolkit/PSAppDeployToolkit/issues",children:"file an issue"}),"."]})]})}function h(e={}){let{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},67008(e,n,o){o.d(n,{R:()=>r,x:()=>l});var t=o(71763);let i={},s=t.createContext(i);function r(e){let n=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]);