From 9a83c73f2172cbc555cb9533c48473b1fb83ae88 Mon Sep 17 00:00:00 2001 From: silversword411 Date: Tue, 20 Apr 2021 04:11:15 +0000 Subject: [PATCH 1/2] Contributing Community Scripts v1 --- docs/docs/contributing_community_scripts.md | 101 ++++++++++++++++++ .../community_scripts_name_field_example1.png | Bin 0 -> 17116 bytes docs/mkdocs.yml | 1 + 3 files changed, 102 insertions(+) create mode 100644 docs/docs/contributing_community_scripts.md create mode 100644 docs/docs/images/community_scripts_name_field_example1.png diff --git a/docs/docs/contributing_community_scripts.md b/docs/docs/contributing_community_scripts.md new file mode 100644 index 00000000..dde13dfe --- /dev/null +++ b/docs/docs/contributing_community_scripts.md @@ -0,0 +1,101 @@ +## Script Library Naming Conventions + +### File names + +Under `/scripts` should generally follow this format: + +``` +(Platform)_(Category or Function)_(What It Does).xxx +``` + +!!!info + Although Tactical RMM only has a Windows agent for now, we're planning for future with script names + +Platform for now are + +``` +Win +OSX +Linux +iOS +Android +``` + + +Good filename examples include: + +``` +Win_Azure_Mars_Cloud_Backup_Status.ps1 +Win_AzureAD_Check_Connection_Status.ps1 +Win_Network_DHCP_Set.bat +Win_Network_DNS_Set_to_1.1.1.2.ps1 +``` + +!!!info + This is so that at a glance you can see if there is already a script with that function, and you can avoid duplication of functionality. If you can improve a script or allow Script Arguments/Parameters update existing if possible + +### Name field (in community_scripts.json) + +Consider they are viewed in 3 different locations: + +Script Manager + + - List View (sortable by any column) + + - Folder View (Grouped by Categories) + + Running scripts manually or adding tasks (or adding in Automation Manager) + +!!!info + A good max length is 50-60 chars or less for display in these 3 locations + +Make sure your Name roughly follows the order of file naming as above + +``` +Category or Function - What It Does +``` + + Consider how the alphabetic sort will affect display + +![json_name_examples](images/community_scripts_name_field_example1.png) + +## Script Files + +### Good Habits + +Try and make them fully self-contained. + +If they pull data from elsewhere, create comment notes at the top with references for others to audit/validate + +Good folder locations +``` +c:\ProgramData\TacticalRMM\ +c:\ProgramData\TacticalRMM\scripts +c:\ProgramData\TacticalRMM\toolbox +c:\ProgramData\TacticalRMM\logs +c:\ProgramData\TacticalRMM\temp +c:\ProgramData\TacticalRMM\ +``` + +Command Parameters are good. Optional command parameters for extra functions are better + +### Bad Habits + +Assumes non-standard configurations + +Doesn't play well with other community scripts (reused names etc.) + + +## Useful Reference Script Examples + +RunAsUser +[https://github.com/wh1te909/tacticalrmm/blob/develop/scripts/Win_Display_Message_To_User.ps1](https://github.com/wh1te909/tacticalrmm/blob/develop/scripts/Win_Display_Message_To_User.ps1) + +Command Paramater Ninja +[https://github.com/wh1te909/tacticalrmm/blob/develop/scripts/Win_ScreenConnectAIO.ps1](https://github.com/wh1te909/tacticalrmm/blob/develop/scripts/Win_ScreenConnectAIO.ps1) + +Optional Command Parameters and testing for errors +[https://github.com/wh1te909/tacticalrmm/blob/develop/scripts/Win_Rename_Computer.ps1](https://github.com/wh1te909/tacticalrmm/blob/develop/scripts/Win_Rename_Computer.ps1) + + + diff --git a/docs/docs/images/community_scripts_name_field_example1.png b/docs/docs/images/community_scripts_name_field_example1.png new file mode 100644 index 0000000000000000000000000000000000000000..403388394605995c2574dad43ad404dbc25d57e8 GIT binary patch literal 17116 zcmch;cT^MqyYGui5l|4MNLQ5JRC+g5>4AjaK|n(99W;O_Rl4*b5JK<0O4T4m5_&HY z2u*s26TiQG?%jLsb=KMYoV)HHfi+n(VKOs3ujl=K-k(oEP38L}^dxwAc=uIaE9l_i z-2&rY>~{%q?@0T;4Z;1o<)Nc2hgUwtxPjZiw*zPZ@bIeQNG~l3aNESLuMIu$@W{IV zzHarqAl~5Kr1VrY@C3Qodiq$p+u$j?+t@gJymj$3)4hv3L=L2)008@%ZD$32G+7JU zy$V@Svp=XepwLGbt(cggKHi&W_uBMdH|njk?@MmXD%Y7(+5>k55IymUe?DL~3;1kP zUiF24N|NSd*(XtJ#uoumFG;H;(PK!V<^*a zYAoK{`$+n?_3z9z@!^Yupy1&Ftdx+5h?4nf7w!5%&W%*iaZL_e6A>O>rQc%&9^Qk8 z4{(>_Bk^5sJiH!!d}=&AtJ_fAg?e!dK!Eq|%RAU@yjSY4fVc1-v;Qx4U;ajg7LZlk za0$*jR%*KcMnJkgL{_?96v@{Uav>3P;L@%cC&jo#h&SowXasyHV9S-U-5ZtkAjCZ2 z#o?u}#B~|%#)j_J z687u8^Z0FF#N~zq(?WIwBH3${?d5`vPXvOq$lO{5f(QLX>T}w~ZF05?Y0U<7&b5xk zciQ}f{K8%euoHefG4q%5`xwhCit)PS)R1Y(ITn{IMP_vqw-ez#V%tH=1qq$Kv@!Sl zzZqaa?c9E^n%T|?OYCWd$$craIp94Fl)~i579az zY(gJ+Qu&<8rz9DQ#v2#jTh^_$%MyrzwGglU5Ud3hDU0i!6pd>8!f6(xgme*P6(p?UMYHupc;1iRPgY7A~@*xnE zA{tfSUw77UdDbc@j4w$eXQv!+JV2sc#Nj$xP*78Q&}V#vx>}H52lV zz2hp~|9ZNCW1~|)i>{MJN?xF5;gf6*cw=6vk%B*QF{P6JB6zJp z0w}={*wsg`b>mVBXu7m!MEf4+_Eb#-^Vtfm;a&OhQc6+f?<~P##~~{!E=+oap<6t| zza9qhF7lHmm;KJmT%&ETj~j3%-)2blZMx^!gb)*-i^zuechtrm?<`&3sHF2*(rhfy zQq0Q7T`9hGJ%38!MtndqebC!>I4MfD*9Iao&xWNI#*Xxates3H(CkSEXAVfZ6BE88 zio1A)nqA)VlPbOoe0ecDjvu#N7*=wvF+8mdC zE-5M%Wfu8B8%R@1LABd3-RRCYbQf^{BXGp@fK%h67nAS!V77oPKub2@qhi*;W?kxr zxE%=#m1Ndh=d?gxD!Y1+LUQ;$$DQA)T}I1*J#^#n;qI#}dO{58JEHIltK8z)YjVf4 zrVOoe7DE9rD>kyk%s83~Ow(W3VWWVip14}L*TbM-oHYlPP|~`NF)-5-)8mpA9mfW% z6xL+>3lNM&6s|mEEU!*EsCU`sf_#g@_ZDEuS;zA7NnXR z7T!(LBz>J)T~1ez-|!e=?$7Sq{J4^7dI)a$;FsB}Ol&(DH=XIuS9c4FRkMe=l_-+(jKI!65a5LP|s! zuy8NAiJ_2W<%hDAC?2!tjw;ZHc`5YjVk`Q8o z&OcIL{sQs@@4tu4PyB$O<0-paczBMt{+mbsqC!7)K?TSL#?8x6F0o%8P(yC2HT18= zyPOh#n%koULh2be>gQ%_YK!(;00Y|2Gkx~{g{|tltrQq<(M&kGUK3-;ncBI{1<9cD z`K`yy^#I`7hH3^wgOKZhfHUZ#kf;4!_SF}eD~wa~v2;+!rQq=j$pAkEy8Gsk*|f=C zq6PaWXC!$y>v&dK2^iO*!6WO0+BW~ejt%mSb5?T5{LXXiVX7&{^S ztD!?3;u0K-TI-Wy;iW#V?|p{9et%_k76dLgaQ|2lmegOcslW)QxUo zZ)bI%%K18bfA&+?dQkU%p z$(b^Rj^Mye9#5T}xSvFu0Y`U`1W4^XAdh$4ItLtPg?B5UJNwbeTlcE2TAM(Pl!yq2U# z-@lTS1UXH$c6_xXF`-rcOgOel5gUgZHwzNb>7mB$@KYH=yxB*-#@T(6=F$9fb1gam z(MC>%e&tJ-zViN{zBX$2^!nTJb9x6vv=FcY^?}~N9H84FAG0A@P3SN?Jdyl4@R^*| zEcwkqzvoK-K+?*B9#EQRP`$xPLiQ}4!VmE2_J#OBhi>aP*NDQ1^)R44>BlsRtm@01 zR2ioYLV|$Ulo0n&nFP(!QT{tb5&c%I8|yZ6p2=6Q{4s;n>P*hhg8)8ks}nM=3PViy zpqSu&WvR+PrOQqpERUZdA~4sqjz1)=9#wvfKp#PK6h$rL&jx{$p;4 z>lPxe-_e42CuRB(PdV(bui}cFMGL2SNA(uFphzdFlOQ{!%b$G~$Zj+5?8Rr8J6*^# zH3Ov)+29YIXaF+gbhR|?HaQ34*9LT-AyT74dPbX{& z3NJ2Au&BFbH_j{{D8McJ&2#`S@oTa%Mc#_G!rg8tWFVt(-RM-#X0_h#C^jiPfQ1GO zNI}ZL;>u@XT4NGIsXtO|)gEhlx5J7TGBWo&j?7%MM#H4dR~Dqa&;f=xG$I@uLqf?oY9G82uNBdXBrbw4YAgpIbgPTy@tJgEJaj^>2Gf zre@((7t+gx8l$-i?^cRJ%)NnvLLB|p*HMz7ak%9s^t{xx<8p(f?LbM%5FQ$*L7-S@ ze*R%DiIU=2!r}EZDjjwmvm3u~neP#?#P|Iiv7tPaJ|j2Jp~XbME^(Nu`YebsC~2Dw;CttJ_7GNXYi zuAr?Si_94bUWF_d{f=EI7bWn%!#!XAoA22b`i@B$tuX|y;= z6>$|WO+&5OLXoyeUmYr*@|$VPB}8>%XW!xmh`VN*`W7o1cgIe)GxXQn%t9>3Y?!d_ z9mfaj$IsQDP47=%^kvcE$lYL98_@$e?^ z%{)d3KBK2;-0?)T8SN7sg2Ro_x#xyK9llvtjb9to@P+pv?~6AzEo(Et(iyRb3`C}w zMlMRBHZ;sznL~GM>gXkgy|kr#!rQCQuTa(}H9J_Lu1ch?T*Aqbq0#4zAg`;QxOif( z4|F)1VFQ_e0x5eVA1vIW10?6y3GFSa>HB)98kta(%GofxY8iGQobfSujlU^_EK6bm zXkWso4)SLO6zRKz%~tL?g6);g=%fML5Nn*YeeXXV3RrAaVPA_xtK|>VWnbqpPL|3qI$*Q4PBH1x4c+PSVz93Em)5vp`~&~G*K`8W zLe#|?vTcrgdP!m@oXVEfuj?}4j+0o&@>NdzIYt`&sh~0{sywbV6<2AKq-xjldg`gc zg2Dh-)OBk$rd6LYs=dw3jrUFJx=2dXcLFXO=N%NOFl6rK`?=-XEEW0=N|y{QkC*Ir z89g=oRV8Hw;Xs*J(QEsa@i~$6B-u$_T!&FzC&)tsiJ)Htog2P>eqoHTXOqjyphgx_ zCcVZKHGjLF7=XX`2n<|kGW*KwBa>!3v3jke8IJL>qR~2=Tk3O`(DW}V+ED||{$j5N zw-!^D_sSK#&zcaM2hr6}A4+z|=aQV%4PgRPjUn}~3p@mqmKV6C9ce}M_l1IZ2jx=X zqx7;b{8Tili^>!72VU0jzE3}lW#i)5t$DYqK52^ie!F0kRjbI&n4A?4&dgZN!+4y< zo~&i~ix|acm7y{G7{F&T7HSI1-t4^_C1?Z$(KgELqKi5^9@fC`4;FBKquIJQOtwxo zaRt~bS<$VD_>s?TXD|2?_PQ-PX051CZnj(?-Jf$~ig2P(RV}Xm7OB^XAg*l)tgE2$ zw5Aq$iop6rafA9aDpL|0hsP8W5Tz24?0b6Q^rMwIjNt?Xz3TC}rHZ4)y(tSvdaP(lG|zPj}O8grh^Z6zfSo#cRX zK5PQose=o?>|(uo`n&GnC1ukfi6D1wtpZ55da@s)SK%!p($eh=03TgVj^vI5<1Y_!kb3VKx0tFAx zuK*atWdk=-r(yU52Y}9yGJfjYi>BT33BCf3$6^40uKF9UkajuYx|HeMad$L~N_9Yt zywWkNo_|_HYkR)=%Zn3BR{XIc&C@hhI|HDWxZmb4k-tSDO8|jAVK2O_poMNGv2Uf3 zpEYb5@$j%0!ryt9=_bO$vVI?}3w2wG7Hs){Ww!z$2T$mJs6{~RGJX2QHGVfFfnX-v z5|(l9>TLqh$@~OKVXv-(U#O*W&?6+o`Wpzfy5m3R=noFQ!(d(xtNzUYNf$Erv)Oso zVk#@8)<_m}uH&asRQJ|J1O0iib#s9NimlCCf?qyB6U9?JKtC(!RyLA@7E2hFsG^Ff z3R(#r<_6(tBg3+dqCt`!yNrb-tB!g0nCw1V#Z~d_>A(-WiAko5Tx)zguZL%Z98H1! z>`f^5Y#VxR1{SNd4{;h^#N1Jl2KBYtdC*Le&oR{lPW%n5()~LS6nt<)G9G^TiFK@} zLSK^t^OjeXtHqux105|vf-!cNfmCkPB8qW+$@yE&ilRub3I*<5MM&LiE;4gX5=Rkf zRm2Sp)(04%GH>3fIT+b5?ZkA-Y zUo1v+(L#_+jH##DHdHnfsoYgE8j*W@S}w>6?5`gegY?u{dFnFSP>3SBJ_FxoXe>(> zym-i`;Q$b#f#e}?M7>xz?T82X8h{ztDG^pA%N9S*F1Yo`ixqx}ckdQH^*jE@2nz?? zNMId@;(EgWlaaxHxjp#z1Bw5Me7U#^mzPTw+4BVP<}|n&1z+WTs6>xlzLqX}?Zc+s z(bclo@k-=8&b|0!mtQpZb-F3~ENSlnVt4Z7I;jq6ybf6?C6c*nE&0eD_d^llxtcgC zuG&0&tC7et1LnV=&Z6~8%_XJCF9K1QaQ|#GdMffWr>2FCDTFt2& zyq170i`>Q?W9#irn{+n<>*`lyUNn>*P2;XW;9rZOLAzi!Y?kBgZ@JKE-ec@E0<@?5 z)SLUhMse_@j%JLHmv47MOV8eHu{Qr7DL}6TQN0;FDM*A%uT(|Scz=-E$-Zdcy&Q2G z3WbQl%WkGKo9uoOC(Vtq+O$@yfpU?oyO<7&O6R)p?Lr)L5#bK1%Xi6qi%2y%Ix;vX zc-)6KaPybsj-PJz+)2VG%(no-UQ^4LM1*n7ZY91KJ>3|vp%2o&&1(8Cp3Kw72uJb3 z$nfdhzO$rY8p@y7G>~-UrepYQDNrUErodfMN=d=ylx)CLpkTOz_eq}=oOq!oPMsov znEkct6Ct^pAIs6!!`gXLQ1mRyJ0((Ix2x_|kx=CUeSZMA{Dy{C`8{0&0g2QD3THAa z%OcK$B>D!-vt@gvJ&2}w>2bt2m$5Yrj!nXv5nLIo;CL*S+Ei4KWj|){#`gnB>e+nc zvTrt|VbUe&SF5oOO~Wde<^I})n`*x`GSCAK(stc?I-E#12B*DrhB`bM9Gl#Et8)h1&Gs#ki&2Y8TEb~` z)GVFk{!nRMr>8^)ZL}}3YV_nV*LB(Q{ST5-OG6AAa`;dJ-d!n>9;%otYLEomYa%_0DX!V=DqS@67|-1pmh)YpEs%+^Zo zSUP-fQTNxK{>slV{~Su+K0Q=x+Q#Bmbjo&1-!3W7;MM)DrR@^NU zom-G=l31pBfPKy`TWy>EFvOGw`>ye#Co#QZ!v-3|K32kpj0)cjCw*u8W*n${r@qT~ z0$MCNGy>&DT?)>o?YMr)4lnK=0j=CUC&50}fuupP;ryb>%=*A4P!t=}ap5B+U|TB( z0%*61rhe*|Q}z?uMqWt(kj9K>WFJQf8(2u!p{~l39rVJ-n#J;vWfQ*(_~Y1LWR**#kPX1zvQe9n}9n=F05!|V^-LG_XPBxG=; z2I3AuZj!$L3=6CC#W~7@hcAU}XiO+@-1HVC4QnZVK4f3nAhez>PHM|Ez81{P27rQ_^u3zR3eWlM9y&&0iushPSmeF7Df#1mBp7)(^B2VA+;S8A zwO9FrU`%Mi7TTi6q56!vp_+?_|0G7Zg~!{ z4`M_n6e-eZ9`EpHe7Rrw=bn`sra0xnYMl%#&5O>kiN1?IzFmdB zyn!F%p-G93)qY3#?=1fV4>#^!_l2*>#FH}HH<^(!+q=bSq^(FFzXiSmriE3%?fsfS z_9cH-6(wusQKB+d(>L8@44`I*7u6zf+jghAH=5-_#cdvc|CN9KK}FL1z58-CZ$@C9 zZ07NNl>%`wwY|$L(qvP+Hf#@zl*m|<;X$0}i}$tRNZq_tk!CGH#{!c&M7W*EEmpo` zD!y`edP5=7VvWO3#=o92kA28=PpEdq660Ai;7G>@(;UF?ILcp0_@rCs1vX}fvrP_W6b83JhW@_p0o3@`3BnbnhMR@pR0 zR&eY|_{dtyUs#Ht5w^Rru+Q>J7I{mPxlU9gDIeOWn<3mZ zybx|O1y|9TuycDAO-;~V^*utqV)gLLd4b0W$@G7*vQ5dRU17r%z8AqThadIJYvb-Y z#9ROs&7+EhSXI4Db+}JNAUwEX5yGI0)c76*wdEH=3|du`$4F3{3)AGQ$|n}H)F**f zOqu2@@d?IU)s2(t#64tX9{!xbVNh(YxHMC(zpR79yg~%gy`hU?;4freiqTMM{id1O zJo2nrH_xQwB-%U<#NKXr;s=fN3brp(ko~BB@~B`~ugE^Mqr1T0P06s)rJ7FCKUBeCgqnhj&?dd|u8B&m*zkb(Sj*`_deM?v`L!9&dxh4h#Gqp>W4i@{=L zyK_>UC%2%*mkm&!QYJTbIe&y>35q%D=M$p>qIc~~CAD3>oJy}_A8+6e?wbt5;1k`;qy9o-v# z#mww7_APHV|K+jeW*;TJ&}=OOxOJ&yaJ+IZNheEsx!R973J^BpnG8Z>48338t@_Nk zax0?n=e%dgNPu>wut*IsH+?P>GEwxFpqyup82M8Y6zt)*ou_6&c$Ygh$Pm7$G{QqF zn1prUi{P*4Eb#_GUg2(1Zu3!28sG=h;uk1y$QPe{Qy;@~(=!6ePw|HGx-<#YeZaiw zRv6?3qY=*Q4*5WUA&b~BL`d9|zKVTSkedo4W9Ph0yz`d#_P89?vpJthqq-AIu-!sF z?3i>|{i2sORnsL^fv`jL-6zH|u@bPr`h{z=F8vXeDXBRkC~UgR0zmzSuIM!e5^4kq zNu%nIEr zv@xm3@pmKt9?$@TANpUj|CPRTy?5_I5=Pw}Rry$O{>*)0?lD*6*(V?_r(XQozw#GH zZ8(+a^j~T(xXC&tkl9qZO4a#Iv1#h)#p2Cbee<1%KT!hI4Zi_uL-QqBoY08J9HehR zTQ6tak65KSuI<=@v$NZWY*-n9q4-`vU+5GSsnMl;tDX3F`$hjG5EXWkO6#hIR2T9? zuq6}s^iD~r>1AL^4OO+=CsUujG$lgb_^OZ#t@VT?r6SM}BdFJDx2qrCc3 zxXBS#x0JJcx9O7%K9319zZ;`eylE{tPiPd|z9#%)PUH`Y>`oWX(7`Hvyx$T5^TtfL z-FZ6v)=@Q_{5V2+LsY#m-fsTG=anH8GScIVNvy_(wHD#YWKwCFDG5`MTWR!Py30L` zSJiPY*kB208ater*m)0&jiG&Qdu_%+iYcivD}XjkS&fsNjWURZ;wNt~WG@;S3?01R zJ^TJnw`u6B^*|{KZd+$TDEcIG2Y=AS(f@j;#HM)86ZQEegJNJA)?f9fo_fGy$z1+< zx^W6|x~=6wtj64uQ8SF_b%s*hUBHn-(o9&j`^Bp1*wSD#s$Q(TV5Ewx;p%%;kzo64 zB@&22@VB9V@IMFeeNKo6CF!Jj4}(6(<>cz`;!}s=GFkt-NZkLCzWvXEJ0&e(e_>H2 z_)q)0=_8F`JS*1yftnZbzHP4xYIbOW-$FY@?m}?NcW}%%bxuncfeBO&+Jw?yXSx<% z9E=)2xwQYitq?>gzTB+LYPnf{f$9&{UZ!rI7TpBjyeTq=1Rit3+hY<$8mF#DnH7c=Iy!ryDViZ6U=dKU1* zl%)7zJFr4V!Sko%YOqHGwD=xgQ_gGDpxPwtLSXl2Yeo0#6~!Mo%5bx zle2J`$w9T$oGd`EFxP`?tz~e`;2ln9EibGHf(=u5ax0Gg6%Fex zc?O2%ah$Id4(u0m{A+9P7+|yNxFhV;ZR(RUXze(kGL0O`+K*Pz5#GhZSM+Qa^0B?_ zUeN&&W&U-SUuQF;!q-DePBXv~Z&%c{{jylbqD(<^ulFS2c29A=!7#?GeW!o4-6%hr zqu#d95;f>$E}ijv?GDzRS0lVQhh_S$ub!KJ`gz|jB_&v~(v+y1=0>VfKo?;@v!l1k z7%e2J3Vc}8=fto0X^(1@`_wZ|Biz;OFc>I)dWp-Qu?BhTJtJo4DtOsF;V0aN;^Mt z?XZUsOHQ@R&RJ1M6uuHysN6-r+PCZHI78+jSY^w7c@#J&KdX<;@b4 zbZLqg_@R~#H?>Qt0Wnz(;5CbUx-4O^L-;WjI_!L|DN}Um?(B2F9+%996S5T)*hrYd zNvO!oG@p*<_3)fg33oQHu7QIQk0A!W++_5pv=r?auexT-$#!B2Ej~cCetvlpO-XX> zf%N2^&|wzfqOj*bvnM9)8aXtOuVV^Axs|k5y%yI?qyJ*?ZXYWn^@tr|u!h$Z{45qf zie%1mfTyc?6S?wNMY}BXONLrwZx^Nz)!SR25pK$;MWr%;Wx6{8#tWQT-Z#??gKX-Q zqWZrcFf(=Bs9WQ|^b}65F*77O;JIc}n{8J9aNql-d^YpqI>Y#X zxqmT%zdtW}{ikKgU0vr~gIQtM)7N!knd$BfyxT$0(x=jR(hWM@{Dt_OB^}@94TL`{ zrtF~~yi_2Ye&{2c75rm%NOtquus#Alt|N&y64}^(g7BZ7j=_oj zH1+2l>`V{Pro&{E=p>_+1g_F_e+J4G?JRX4XUXuB=O8nePn`yWd@hlk!-lU@d$@&z zAB`E_`MTmAn;FSd$<+moe~vO6bMvl*72CTEb9E>Y6VqC?^n04GBUf;`*{Rh5zGA1) z=x4+W^4*Ns)H80;23-qbh9r-u3{$m1!QyKs`DuTq9TrZzUjYF^k`5q9dpUiOhhKUE zuaQ40jBn^+?(;`&bick9ONjJ>ZhmB%fwn6xd^g|F3G1$+#bQjgSR@^6(o+OW9E-T0 zbQr>;8;!MPQon*#1qj{f`F6S&|>)Z8g|GssJ<}8|4Nv|r@26) zEiFWc&$$CEPZZwNfVIDO$@--7(gj&i2S*UQPuQG9vJFKu#_N{{YSwvU+ zgmrUB$SYIm_S$=D^y-@rFJ0`Te(vnZ{&Ca;`W0V{R@rl#+6g8W_O-z;PUz8WkEodq z0Jq} z?57>8G%hIj=%;+nRgV6;V8xZ}d7HKF`JDc>OFjoKdLR1#J%p_e@pXel+ZKcD1y9F7 zt~cw~I(B$RO-V94KQRT zF_4t#vaNj1lAukQV3rdfi#g~yQ3VnODqRLs>IO4i+3&wey1Co6{SbO?QR4)aaEzEP zhQWtK4N_*n#$Vuv3Q(PjRYYqaw%IM!O3)qJ96l^V-W$q_&^*(~xA)KOYhs0%z4p0? z!}TO4xaL5fNqE)*HM?lsaGGY)kPa44JY4Vsns=G-5OhGr*~SGTq)SjEO-ToHzahMx zzXf~#L8^1XzmQs7BbJ&Ifoq{G&YG+lMX=yN;oMoYq=PQm@E4>b*T96hAn6h8rYum{ z^BoM^H~?;ij5;kJBi{t3tCl!nzj%7y-WY)znQz1o@dLI^2?2z}5a`RbSqbMo*m~4V zr<qsPh=T@L6H{m2dDpX{10%+GeqCZuIO4?^7<8lhLJn{0Hmxm_BlE{{IM15B;X@ z`)3xM_t;xTts4HJXF23_2yHOu!GYZ0?b3Dn@f$>}n!gX8TNIky9a1*1-C)yHE(8>C z#X7K-NG1{+hYwsk;QC$-*K{^h_c{pp&CL%LhTw0cE^l$co3qya{pd)^i}u%~P*Y}sZ5MzseK?w&$z4pIDrC)Is8%oS&mnqsN zxBRaY8YT2JtE<`ALAN)tfaIimTve~B$hVxPRVh22PiKSC=RwmhB{(bRcX(2h9a+j0 zx0P(6I*|t-W-p=oOS)RHQBqD>X#h81y}i^I;W{y3w${K}G@zCOczKv$%zo?r3(&RU z3cCT1S z*iLJ|-{;rcp<8pRWj;{cyggmohAJ9&fx&XFKgCv+vZ{CA{-5y|3yRozcj>> zp@QsXi$lek_=`hND8WawEv&r1m}ydMEM^~m+bC_9gJLm>+M)0LXgDLTZ5I0l4ogC| zX&%_JKh-OA*gN?N@|jYS6;!zYT1wHyoKL4O^W}!Qk~DsuR@#XZ?t<2=;MaM*cz7r) zM2!4ii%ttJvbmK#J!rDHX4|}bwr1~e9T*OQv_);d%xL!Eb7T>)P<>Kha+cu^^WbF>4(9nVri_qsWk>Yx*B2ytqCi_oZENlV_$ zU({eza%TxjNGCBd76`h&wt0|menl>h*-b07uVbexJ-G|0xkrTt*wh*Vm`3V5W9{sm zR0k)Te$0;t+HJvY};6nUnSkF7^HT>;pHVl5B8US z`%B5_ZX!XkgtD=Os3Ev@MS+X^i>B(oF!txoWO>aTMCYhf1}pd)PfFI928~ejIeqV@ zMN`Dj%9Wb$r|69~j7GnE8jRzVkudim&dqJP2VFnkZFe-tl}ND$ttsRmU4#w@20BL0 zyy~2@guz}04Se+Lj^r&|aF#pfI|#NCwIMZ=86S;6+wh(!UkB4XRocwBj_lo&yXZN~Xu16U8 z5Ep^^CUtl=9Fi?_(lq?bPUe7)(k*8HU;73vk(xi|DbBgtvU~b(T-=xCDgOJ{Cnf&V zIV|UzUyYfwE$Ihi^r^J7akRYmJJVw2)UY2sr*WhA;!b&v|v7u zSvb8t6`Un3z9Kb4e_{p%od@jV{I#cZxA0D&5y1zdAt0PP zKgOxG_c9t*-RV?`DEoKLaFxT~sLyoBdIt8#5Bn?WV@WUW<{S!U5a)_z>imS2 z03V*)b2$P0h<6J=D|Ik81+$)DAty)jo;r8J(#hkO!6j-KZErMjBMo8*&vcJn6ZV=?vk-!C2pi={0Z%EImND$Q)%)&R&+ zJuNpki4>j8Bk$zvg%?`8x@L}*jpA64BccyYP!x=&>+}PQr)q0hm`%>tA@!9SHFWE533-n z-};=Y*g)Q8sLax$&ZKI7xl%)a?33~t6%iBDyLp=}W`LIojC zgy4SH;LC!tg(9islzk(h;WNShQB8l1Qx?sV0GnLGWh4)UqbYi`rX9wP-i0L>U5O0M zTs*i%F{l&n)p6Et$WEuG?I+D>mO>*Sir}@9?cc3#Okt|hY}L)}D^Ns!krEP^tb8QA z=$e(ayij~?1U?qou1+%N);3e9$;r4+`p&fTJ4vw|Z*@4y*w$}wMtGMulAlyqL%eE! z5{j*!zrD;raYBRdwRNB7A;qOJA5A6+wO#LW%`O|K;I8`FpiTEK4LWRE!F{d{hV@i5 zHIul#ZbRXqP2zuU{xzvt^lKy9dL-Vxn#PV+;$|+DZiSORpZ&^mz5Ncu=-=(HWO0thvSW4X274pN3w@+Z?u_l|W@+zY9J zLii@$N1sqiOSZKK0Lq4yn+z$FaNR)D^oT>d6dq0Mx3U}typ~WWO0@GYHQw*BiP_F@ z{_hf&uG?Bb)K(0)#=uq31N3}`4sZUNDw4Y{*y~)wzd6kQGwe8hKVwBJJG@9GTA9=e z8^qth4?v?X$5qEKm@@YV&Wr@FV*k!QVWZ;poP*P)4p)({+0~go89+k%21`TL{Ej>h zx^G*o)!c`s!{o9GLzs3NUD|tSOcF+2QV`#uC___p*3RQ7+JJZ_TQA2*zHeJ{$wvEI z@=q0>05tM(0lc5@9qntLa{6NL>ghUyaIPQ^f}NZ}nEN}wXrVxe%FE7Wp5Wo}GmWXH zVIBVjl-H;5w2F5G$Q^kc8`TVWJqA!oV7+W!VOM6Yw;eKcb!PO;RQSTL=8Cm7gBNSBVU8UNUVZOl9qIki5Wo<_A zX$>-z!3U(=eZ~xk_TZ-hYA`X6$B?*tkIk4ty7#!leUSTcZGRJ}##39CXM>a}Bf+z! zzjD?ZRQ;O{k@^gym+4Q+*z|I#d85@LF7n9Zj>So(^k4bY^5DO>FzEkc(e8hADCddL z`kGH=c1wwaG^p_^t)~b9)VJ(GM=>J@qQ#eJzj7J7t-zV4f5wC5EpBnA(ViTA!>?y} z$Z}gwpy_$jd}R4%J%wqvCY6-HK*L25gU1udqyRR>PoIP|1kjUp@-YWo+vdcOP@2ID zTy^I*v(aq@6@EPkx>*{5P8%QY#Nvwjf!B~Ik(>rMQ?x4)-Yl&W2&k2|P*a|RPi-jr zwk*G_@-xgkd`X7oJ03uHNu(&ST+@log!g!pI(;upQX?FK@_1UG#8X4O8^ngt=K-$) zPDYs6bb`}5sOqn3c%r zN;NtS0F!`DmL%i?@@=E@Nf%TievAgIlx%AfBL5;928r@xPtHewq7)VnDvP4SWE?E3Ma4Wj+^t7Q*)I(Kow)hk<(|Yu@4%BD z(@e{SL%cnT2T`gsDlNQdAxuxYbxF}cI_XCjg;{w+#5W898)BjkH(s!Vf`Yxy_B=@; za)u%2X*>w&u&j!8;qlV!-#k$|JKKjj1ln_(f6~={g+@~?8Q0A6X|wKaO+|8J2$kyw7bqX|rY{^Rf@ zj3OCmCc=a8=CXXuo&9lO=1Yqj0OLxc?Mx%Qm|WD1d>B}xkhnkl@ZXC3<~ONFH2!?X zxF>3o9k5N))&t!V+u(wy8!2s#^W1t48q%gj^M9+|gy9x+OeDz`gy|^^(X#Vr?7ap2 zG_~USjCw$&z~mhSnE#Z%U&9t+rqzKZtnDD^rJGC4oe!wo6{{!G`Z{_= zUZ|tOf!ATRp0Q;*E4C9od1a1x-sCu+gP0p_cvpfq8&~2%-<}mL@M?z=l+`pNBy;C@ z4f!^#L5{>Ww8iKII~ICN5@HBza>23<*&DSC79S2ocuB%@W<1S&uAr~4g|j~#gua6z zuYegk2VQJ%1~K-k+&o(F@yx=9!L#(zzC!ccG&7ernsF4EG8fei4E{7i8{oZbgNhqy z`0J(Bla(<{Xk90OVfAmln8i8{s%wV*zMz!nv38*w_!bRSxQZS&!MIyn3p*w4T z?6z+CMZf#%y2j#bEj0atwAf^Yf;a9I_P$1z(jj~O?0F~9{60=YCk!|}@ijel2nIvG zON?JJWEZ2JAN8E5oi#d)U(+<~e4}sbLJ}UU;q?7OQpbB5DG@gN;j@g8hvGx2=FhW^ zxT&}3k57e?^|H?6UEA`k*fmATX>FVL@j9KY1O5g;yr2B1-uyq7-T%%U$>34m4LOX+ Wl(};1!XDStr7P)!Z=v literal 0 HcmV?d00001 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 84e7c053..f054bb03 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -26,6 +26,7 @@ nav: - Contributing: - "Contributing to Docs": contributing.md - "Contributing using VSCode": contributing_using_vscode.md + - "Contributing to Community Scripts": contributing_community_scripts.md - License: license.md site_description: "A remote monitoring and management tool" site_author: "wh1te909" From 762c3159b87601227a1236a78486bac366e91c84 Mon Sep 17 00:00:00 2001 From: silversword411 Date: Tue, 20 Apr 2021 00:26:20 -0400 Subject: [PATCH 2/2] Script library - more cleaning --- api/tacticalrmm/scripts/community_scripts.json | 6 +++--- ..._Exclusion.ps1 => Win_TRMM_AV_Update_Exclusion.ps1} | 10 +++++----- ..._restart.ps1 => Win_Updates_Finish_and_Restart.ps1} | 0 ...hutdown.ps1 => Win_Updates_Finish_and_Shutdown.ps1} | 0 4 files changed, 8 insertions(+), 8 deletions(-) rename scripts/{Win_Update_Tactical_Exclusion.ps1 => Win_TRMM_AV_Update_Exclusion.ps1} (98%) rename scripts/{Win_Finish_updates_and_restart.ps1 => Win_Updates_Finish_and_Restart.ps1} (100%) rename scripts/{Win_Finish_updates_and_shutdown.ps1 => Win_Updates_Finish_and_Shutdown.ps1} (100%) diff --git a/api/tacticalrmm/scripts/community_scripts.json b/api/tacticalrmm/scripts/community_scripts.json index 89595e3f..bc55ab55 100644 --- a/api/tacticalrmm/scripts/community_scripts.json +++ b/api/tacticalrmm/scripts/community_scripts.json @@ -299,7 +299,7 @@ }, { "guid": "2472bbaf-1941-4722-8a58-d1dd0f528801", - "filename": "Win_Update_Tactical_Exclusion.ps1", + "filename": "Win_TRMM_AV_Update_Exclusion.ps1", "submittedBy": "https://github.com/dinger1986", "name": "TRMM Defender Exclusions", "description": "Windows Defender Exclusions for Tactical RMM", @@ -399,7 +399,7 @@ }, { "guid": "f396dae2-c768-45c5-bd6c-176e56ed3614", - "filename": "Win_Finish_updates_and_restart.ps1", + "filename": "Win_Updates_Finish_and_Restart.ps1", "submittedBy": "https://github.com/tremor021", "name": "Updates - Finish and restart", "description": "Finish installing Windows updates and restart PC", @@ -408,7 +408,7 @@ }, { "guid": "63f89be0-a9c9-4c61-9b55-bce0b28b90b2", - "filename": "Win_Finish_updates_and_shutdown.ps1", + "filename": "Win_Updates_Finish_and_Shutdown.ps1", "submittedBy": "https://github.com/tremor021", "name": "Updates - Finish and Shutdown", "description": "Finish installing Windows updates and shutdown PC", diff --git a/scripts/Win_Update_Tactical_Exclusion.ps1 b/scripts/Win_TRMM_AV_Update_Exclusion.ps1 similarity index 98% rename from scripts/Win_Update_Tactical_Exclusion.ps1 rename to scripts/Win_TRMM_AV_Update_Exclusion.ps1 index bf0fbc90..251c33c8 100644 --- a/scripts/Win_Update_Tactical_Exclusion.ps1 +++ b/scripts/Win_TRMM_AV_Update_Exclusion.ps1 @@ -1,5 +1,5 @@ -#Windows Defender Exclusions for Tactical -Add-MpPreference -ExclusionPath "C:\Program Files\Mesh Agent\*" -Add-MpPreference -ExclusionPath "C:\Program Files\TacticalAgent\*" -Add-MpPreference -ExclusionPath "C:\Windows\Temp\trmm\*" -Add-MpPreference -ExclusionPath "C:\Windows\Temp\winagent-v*.exe" +#Windows Defender Exclusions for Tactical +Add-MpPreference -ExclusionPath "C:\Program Files\Mesh Agent\*" +Add-MpPreference -ExclusionPath "C:\Program Files\TacticalAgent\*" +Add-MpPreference -ExclusionPath "C:\Windows\Temp\trmm\*" +Add-MpPreference -ExclusionPath "C:\Windows\Temp\winagent-v*.exe" diff --git a/scripts/Win_Finish_updates_and_restart.ps1 b/scripts/Win_Updates_Finish_and_Restart.ps1 similarity index 100% rename from scripts/Win_Finish_updates_and_restart.ps1 rename to scripts/Win_Updates_Finish_and_Restart.ps1 diff --git a/scripts/Win_Finish_updates_and_shutdown.ps1 b/scripts/Win_Updates_Finish_and_Shutdown.ps1 similarity index 100% rename from scripts/Win_Finish_updates_and_shutdown.ps1 rename to scripts/Win_Updates_Finish_and_Shutdown.ps1