From d7850a18eaeb62a27dd6b40fa24e11260759efb1 Mon Sep 17 00:00:00 2001 From: Erik Mogensen Date: Fri, 5 Jul 2024 14:46:54 +0200 Subject: [PATCH 1/2] Update installation instructions --- README.md | 28 ++++++++++++++++++++++++++-- media/UserConfigFile.png | Bin 0 -> 8604 bytes 2 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 media/UserConfigFile.png diff --git a/README.md b/README.md index 09d32dcd..17ac40d2 100644 --- a/README.md +++ b/README.md @@ -14,17 +14,41 @@ The following software is required to run ServiceBusExplorer. It may run on othe - .NET Framework 4.6.2 # Installation + +It is strongly recommended to set `Configuration File for Settings and Connection Strings` to `User Configuration File` as shown in the figure below to lessen problems when upgrading. +![UserConfiguration](./media/UserConfigFile.png) + +> **_Note:_** There are four files that will get overwritten during the upgrade. +> +> - `ServiceBusExplorer.exe.config` +> - `properties.xml` +> - `message.xml` +> - `RelayMessage.xml` +> +> If you have made changes to these files, you should back them up before upgrading. + ## Using [Chocolatey](https://chocolatey.org/install) + +### Installing first time + ``` choco install ServiceBusExplorer ``` +### Upgrading + +``` +choco upgrade ServiceBusExplorer +``` + The default location of the executable is C:\ProgramData\chocolatey\lib\ServiceBusExplorer\tools\ServiceBusExplorer.exe. More information on our [Chocolatey page](https://chocolatey.org/packages/ServiceBusExplorer). ## Using [Scoop](https://scoop.sh) +> **__Warning_** The `scoop` package is not maintained by ServiceBusExplorer project so carefully check the package and the URLs it uses before using it. Also, the current package keeps the old version of `ServiceBusExplorer.exe.config`. That may cause assembly loading issues so do not use it for upgrading. + ``` scoop install extras/servicebusexplorer ``` @@ -47,9 +71,9 @@ Here are some guidelines concerning contributions: - We have started to migrate from the old SDK to the latest SDKs for Service Bus, Event Hubs, Relay and Notification Hubs. Therefore, new classes should not depend on the old SDK unless absolutely necessary. -# Development Environment +## Development Environment -Visual Studio 2022 17.2.4 or later is required to build the solution. +Visual Studio 2022 17.8.0 or later is required to build the solution. When editing UI elements Visual Studio should run as a DPI-unaware process. For more information about this, see the [Visual Studio documentation](https://docs.microsoft.com/en-us/dotnet/framework/winforms/disable-dpi-awareness-visual-studio). In Visual Studio 2022 the informational bar looks like this ![AutoscalingTurnedOff](./media/AutoscalingTurnedOff.png) when it is running as a DPI-unaware process. diff --git a/media/UserConfigFile.png b/media/UserConfigFile.png new file mode 100644 index 0000000000000000000000000000000000000000..45290e3bb48737cc28ed2efcc9b8239d25a99199 GIT binary patch literal 8604 zcmb_?byQo;*DievEn2jApirPVMT$4H1a~OzCAd>uQ$dPLv7*J@UDINL6e%tNQlJzF zE`ea-gZFp8weGtAeD|((|2Su#nYH)K9@#U`Gjk%fG!#h)=?QUga7dJu3n^DSeOD zY5d2^Lf}kA}+agmIz&-BlGBeskyF?UjODtIHe|E1?Vp})s>I=sJg<9c; zLDC|wqi{-E8Z3DcuA=P!tDsEW7dSLtd(iK zI`hs}k#>Z_D}j94R(6fu=!U4_562zDgvSdG(b5R;gXl9oe2@qOmy*;x$570Xd?1b;0DzT z$C>d=)4`7=MZNjHrcUodR_*vW&=yr32KQ){lfX_~cxG#W{R&lA8)eDksbX=T9q}mA zpxAn5ZX|RG{!Z1Hm>^F|mdLss7t~1$$+6boGlNT>b>v!c!Fc)mI zMBaN%s1N3IkrP)bbJ^n$><~UfZ={)p6&Bw!(OBohz7Jtc=YJ+&_Z%K4VE@!Se+Fh7 z;7%lO-g$yxq6(gQ#I^2kcsvhF_jI|8dUw-J%n&s#m{ga*}jT*Q4C+V185|zhrJnYV%0jrZiB85qwOMT1qw!guHqqG+N)rn>U)TfKYEC@rS zhAVn@h;2iaSlR5J(^>8m9Z2V9nsZ1-ti$A8hvFPpgF2DO(fL8k?&Se?qhF96nForv zl6r&{Fu%bN1$FOpV)c*sx-YN~(GQjJSwhJs4i43Wk3Da|5Uv4V*w2_qGFg0)vd8e@|LBDq#7iKS;_3+Kb4sYsK+9ZCMnhb~H=wg>OKCb&y2} z@yM49dY-#{rE4~B!4vS65<%Vh%XafweZI`ishchT(KI_n1W zzFPSM6hB$=FulSAfC=L9OQ4T~KWP)mh*AGr*xYAMq2xcuc%i?b*GEsQflotmEp)dd z>JcwsFS5r7DP(2;hU(e-4k!o6{Ohj^`3KsgH4%&cg>PF6!Uwwakeu-|p5i$8bHmUJp z|5VJI;vO5TeDS!P+RLVZ_~wZEy&tO2ZO8w9_YeYXm}*YdOwuhZgBKnE@+jn}T;|U8 zey7h@_&7=3HG>{F{h383iNR~|Onjx;Pa92X~Z3z&z>$%P^rN7Spn&DZbFzekI;In-Neu3>*$g&Cv zjj%g;WerYR*V`(cBIXk51IL^Al4VOKo#mz)rH%`q2nrWE@c_;vaUo zy-ZY*nTcNn=_nB()0kntSjg9^IkLB`Zwzi7!DopqTqqghuAO;w&0r&rk_iW`D|+j0 z{w7tNa&j*(BfIk!zl<-R4D_!yNjzuq&|Mv}^h`0tZ`dtOOGV{rwc38ZYv~#zFsM}_QkSHk?5>s4 z>Qh#wf5HT57bNKbY$Tn;l(RcRf%)L;Pib319Myv17qa8Rk9Wl!Hi?Q!t&!jDw5(k8 zRAVo{Z$;Bbhl)A_->dFit|0`!u$%B+9NbDZ|!z>(lmP#V{s_; za7|A3LTGsIZwsu!b$xbPkQlU?kylvAhGAaJUw-io4?lD&*&$o&v=@p-MrcizRojka zc#LR0mLsQI2Fk2{y?bPgGAaYt`%^3`^;zGcL7v*R8JqtBX#txXud9Yj zcpSxJsIAD~eSSq3>Gj8LwA{uYe1EsTipU3MYcSeJpkbC>btHQGH0fL49#z?>fPh0X zp_;$|{A=TiAj$Zzj|gt@*i)a4kRQvUHkwm574K%mi#5DncGOzNls#+A`W8@rq~{~| zzQH*&L6Vw^u7jhHv`;ro^Mh#A2uBrj^>+|viD5m}38Enx?lj)vt98=(!t8|zEy8P^t96|>Ts z(7xjdLVez#E%zzr%yrt5m@GU*O!f2A{VZ;_Oy-9J!1%*dkTWr-_G45;;d}1R!OZ7rreoi#@ z4K~Pm;SX)E;uLMFO5iXpiYHD|Ms@mJUsbGsA&S_0J2UR8a?Ov`mmz3P*Vqpqd*c}S z)lQzrK1r~4%_BxvtOEPc*zz)%fPzfJgF-X!-2quU57L{tbZW1`+PMV3+|y4$sF6ru z!}Z5~f8p`9EVgYop1p48Jxf8KSpb0&NDRID7@<`Qz9d3jQdI%K5OK$%CmR}H4?lzi58Zol%}#d-(H;K> zVkGSbOK&prz)|g@7Q*ySKh^t6H;tr)Hk03*X;yI|M!0WONloK4xJIVXoupVhJ)=2b ztSRx~hYS@OyVGH9E;X z2`m|TkvHWXxOl^9z|eB%QRn!IVunJ%9d%6KRt&{GR; zfAbA>$6zM46-Z%Br<~b_xddrPZbo#{^I%GOYtH*!)#2FC_T_H6A$mfBmEKB^=kelc zm8KsxM_m|}K57JJhhC?j( zbfA|}nzL(+otsKC|6qxjLNRwm;?!Zpnth-HrP}DrP(VQWkWu#$Ogr3dMSJIYU{5~$ z5$1dgXbtyBDva$)I=sjS&7FspKjU-+2bodsR46n_c}DlnE|<$Jx)vJ`(&epD#oQ}= zG~H68ce0xz7S0vT7NhhOWD$(k`yDCF;?-fEw})mAfgGS;F>%&G@OM9|ov5|+={V-T z7KgfvsYL5r_QNutH^Itg^0)U$R|}xsA39%_XAwPEN$Wxw=L@N`uCHjWmIm;mPg4v% z&_2=(>9XmMI;BZ_C#+xg>RQg6FYw0$YtmXc-O7|j;*)5;L3u)N~xo%s}obFkr^f_)uq+ftd((8cJ{N}Q5u%z2-YLkp3 z6D%6yLnSq4Z$(fc5dUCD+}#xGt9a#+Oio_D^FEg%GSNP1Db*do+RfT$FimP)TI!>T zomz1cSNu3b+=j1E2D$o8zNcFgre$n#vaRzz{}-8`HVY82 zz?@b(ijM?5ecpm$a3+yEHh3!+ZsbeF;(gjOq%srp8tVJt+mk)nuqoU))oU12Z??0Gv>WdC&fS?Ol;KSmNf>3e`c&LYrq7B&cv~SYT#kon$W~! zLR;oH4kT)~GZsP7EgyH}A{$@VLi3M+zMYJ4ROj2>qbXC*9m7s$u>7!64vQnwiF+&- z<(*pgY|1vxAZ2N}*`pyMm8GVDel3zfA1O)ttm!ii)Q;1Qw>~^&&7t9QyU4y#40AJX z+D6s)+Cu-;3%)RudYu6PcSR8R%zS(Ff3s!ypA0{Em`sKJq$OY`Q17NSsXaH1@U5) zgTDlwuk#6n#vH9GU$r#Q7wpo&YPDsoa^sA|KVF*8#~VFlDEJfr-T6J#dio9qUa6;6 zWZoJO?Ci#)ec6b&C;c-$xz$*-pW9a=1KcxKS>K*LJ2l0CccW{A;eo$DGCLjv&v^uZ zd8~>=i`4fRXZ^!mH_Ch>7_#n{FXeSJ>2?pisZ#=!yFD!Lo>oF0IW!oAy63|5FZsUNg?hd1hAv<)<>g$?v`%D(*N)a!QRUiT z$ol66U)(RpaRtyE3RRe1<{5bB1Gv?9B?Qwj{Bb2Owk~Mp2RGjEfbVq4{7CE}gI?TA z!20DUvl$kQKofi+!JBHnMx|@~8{E(f-^J}Y)^ve(x6v%fEoM9b&IOP#a?KrLC;f#~ zQ|(Hgo`V-$QLHqWQ#(F*WbPa=pu){PhAQ^GwigM{jga|?)SjVonnn%V2`9fdQ2e`j4)x`n0n|n> zVR@C6N0XMB(NKi~h1g+z=c%$mGM2u;snIiHcBV^{GImtsijL(d{HZM|%lO*#pqAmp zo=*NoW)yzQ(`j9N0xD2w0%erBut?KWcqYk5H{*xN&t}JF+uVF+prX|fdF-%t%tZ(p z*$w@z88Ku!d{@&KeLc5T-!ZxWFghJr;-H2) zMH#)umpd}}mE&n>7OjxvPff?!pp0Q`SWNgo|BLyNl>AF{R~LztiqoGOatjy!+r;|(8m@vf(q zRSZVU2%W6J*)a#bq=&=8W3;NhY$p*|l&5YDOA~v}R9Z-xTgcHT3KkNED3&n3@PT+{ zH(nA-sed@8&PvTej;hjS0@pegS5(Z;G;?C^BVPzn%PN6Ft(4wI=Z#Yq)2a6M(cP=q z2hS!fP-vo5p>rX?>yyd37B`FRGtVhZ*}=KvX`n`ELOT%{ddKw-MQ%soUr9g-%H&`# z068gUG%oK*+;bj&9g#_G37wCLL8q^rAPc3aQ!=hSSSgTJM=}bh{NDkiqA-WWKSAkr z+FfNu&7nDv_Puu5Q1G(g+v~#7-Q?fctzQApmrKDveMHqA!{Z(?+c}roDnQnH+s97( zMGiIb4}}QGLGPZ@$Jubs1+pdR+YC$BedOd&SYuaYAO!jmwnCUhzjk@#A=s!oC5ib) zig^{;QTuFCpIu?(QWk4<1hkT%k*OBxOT?;dh4djS2>xQoRV*l?+Y5P(lO?`4`7%q{H+i<_9dt-wjew zh0dV>Re@_!IVRc*TFj;k9S_4^*7WyRjWp*w#kG@9mw0%-ywP!As!()?h&3p4f60hc zB|QDjYAvaE_KHdVaj@=MS>DXnplKlKg*e=cVmDplnhrQiOSzbOy?tZ4d%htFTnQ@c zfepeeVs}5CJwfgvUNP&w{5vD^l~D@L=ybjk6Q_i`9w*Ok%j2^XB4sk`bfaE1nV5ea zU0so0Jt2D7@zu2#C}9|R>EDRI0^ z`D>pGd5MKYIYv9HGKgZf)x2)QGqBH$cvoOKYLCvrR+WV4!h+45qCo&kTnrX4kw zZeP=H)bV&jtzk#NyY*oWJT@PG1@MTNW2bmBNy?%5>rhabq1Oe;Zl+s`$_TBl=gHEv zf?OI`)(3xo|9yndnLz~gWxqyo?X1G(u#w4WBW?fy(iv|4^gLL^l$EvpiZ6X?5>5}8 zZ$&20KYIkGPLv_ASN(NP6V=%35`-&e(KFwRj&M5v?md|!dzMqK{(2Ie7}Ew9c8Qbl zq1ZDxw=m6ibDiV9>C|pr8_?}~3_vaVR5GAEA&Q+MEQqMSL1eO8-ulUV&8Cg|mWQid zuL7$FvZJqB_ojQx1r*-q;eRXH_&w84(WI=mOSg`)Xgti?qjMRSqDlTX4ondbruea* zAeiSL#69N3G1eZ}+I3Rvij*xtzzJ3nEjL0P$xSiAypjR6j;7}s zjX;!O^jt1(W04M2vQz|^7FS&l$lx3ua$jRkRe~)ltV6w*39s~A=aL}paOTNj?ZFHd z@^c>vlv{aLQ_C9r~;d>VM9k7H#9RTTT0^?675=&h+JGFd~F57e0?d{m6DP9hAH2 z6<3pb*s}r|#nre_kzgaZ%NwJpLoWAlx77x^lvWhG*_3HBx zR^csV8*6@#2mr>Ct+L<7zcFbqfFncegLIJ>>Cs3kR%FkQTeYSRAI_{Ma?Vq%q@rzX zxjaAwE5Wz}9WD`0|A;*dBvC4KNyzkHK`~bH;Zqjje@ec&EE!2o&2b%f%a^^h){LeT z9f3YbK76~Hoq8&+91V>&y(;g{ ztU@bIz*fKTrFs=|S{th?e$4V`)A=KWZg!~eDpsbphsIi51ZhW$-QKo5!&)h^yt#j& z9UvU`D-VrBHR?wQ6}hxQIj3BRIM=|&op{SHbOCR%sh|PYW2{E;sK%g?lTTl)^9iE_ z!`ROezS}T|qQ*YF5ThuYm}E8i?=9-)&{`5|~@AYHW_jOPW@mmAU7 z*kQT1BHJO3bJP+yCkFq}TCAJST{|6%e7%eFe0EbvC=b#+YgzKylW+g%iv4}JBk5VW zxaf_Q;D*#}jwTvv?Hc({>zFdxkD2(nDhb*aTH_VNtlN2yKjhMD=V@Wl2-|aCpBQ+) z)9Bk_*z~3~Y8vb}D>gG}y~NZIq~d+Sww=V768877LRu{RkG5C#f#?DcvI=kYer@nV zc58x6$Lr4K1i^Mqi#Y~a`Db-glijHB-IRvmv!L<* zMJb_v^wo4a;{9M2lF$9wp;^d(3{D;`#5>fA^999cKME-1`3~W5;Tq@86** lS?PyQ{{u{(f4{j`YN1ILLBW!K`$q+ivb=^|wXEgG{{k~U#$^Bi literal 0 HcmV?d00001 From e0ce92cb88ad6abe1a08e8a1d54d4386c43f573c Mon Sep 17 00:00:00 2001 From: Erik Mogensen Date: Fri, 5 Jul 2024 14:51:43 +0200 Subject: [PATCH 2/2] Minor --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 17ac40d2..453c922e 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ It is strongly recommended to set `Configuration File for Settings and Connectio ## Using [Chocolatey](https://chocolatey.org/install) -### Installing first time +### Installing for the first time ``` choco install ServiceBusExplorer @@ -41,19 +41,19 @@ choco install ServiceBusExplorer choco upgrade ServiceBusExplorer ``` -The default location of the executable is C:\ProgramData\chocolatey\lib\ServiceBusExplorer\tools\ServiceBusExplorer.exe. +The default location of the executable is `C:\ProgramData\chocolatey\lib\ServiceBusExplorer\tools\ServiceBusExplorer.exe`. More information on our [Chocolatey page](https://chocolatey.org/packages/ServiceBusExplorer). ## Using [Scoop](https://scoop.sh) -> **__Warning_** The `scoop` package is not maintained by ServiceBusExplorer project so carefully check the package and the URLs it uses before using it. Also, the current package keeps the old version of `ServiceBusExplorer.exe.config`. That may cause assembly loading issues so do not use it for upgrading. +> **__Warning_** The `scoop` package is not maintained by the ServiceBusExplorer project so carefully check the package and the URLs it uses before using it. Also, the current package keeps the old version of `ServiceBusExplorer.exe.config`. That may cause assembly loading issues so do not use it for upgrading. ``` scoop install extras/servicebusexplorer ``` -The default location of the executable is %USERPROFILE%\scoop\apps\servicebusexplorer\current\tools\ServiceBusExplorer.exe. +The default location of the executable is `%USERPROFILE%\scoop\apps\servicebusexplorer\current\tools\ServiceBusExplorer.exe`. ## Using GitHub ```