From 32a615082ca295c61d08685867cab44987ccc2cb Mon Sep 17 00:00:00 2001 From: xdvora19 <xdvora19@fi.muni.cz> Date: Sun, 26 May 2024 20:29:43 +0200 Subject: [PATCH] edit installation.md and update utilities.sh and mkdocs --- .gitignore | 2 -- docs/tech/installation.md | 16 +++++++++------- docs/tech/manual-install.md | 15 --------------- files-from-repos/deployment-files.zip | Bin 0 -> 8293 bytes mkdocs.yml | 1 - utilities.sh | 3 +-- 6 files changed, 10 insertions(+), 27 deletions(-) delete mode 100644 docs/tech/manual-install.md create mode 100644 files-from-repos/deployment-files.zip diff --git a/.gitignore b/.gitignore index bff8f51..e56123c 100644 --- a/.gitignore +++ b/.gitignore @@ -4,8 +4,6 @@ docs/tech/architecture/definitions.md docs/tech/architecture/CHANGELOG.md docs/tech/api/openapi.yml files-from-repos/nginx-README.md -files-from-repos/front-README.md -files-from-repos/back-README.md # python .python-version diff --git a/docs/tech/installation.md b/docs/tech/installation.md index 6bb7088..6282478 100644 --- a/docs/tech/installation.md +++ b/docs/tech/installation.md @@ -4,18 +4,20 @@ The INJECT Exercise Platform comprises two main components: the frontend and the For a deeper understanding of the overall architecture of the INJECT Exercise Platform, you can refer to the [architecture overview](architecture/overview.md) in the documentation. -# Hardware Requirements +## Hardware Requirements Before you begin, ensure that you have the following: a server with at least 1 core CPU and 4GB RAM, a 64-bit x86 architecture and root or sudo access to the server. This ensures that the backend server can handle data processing efficiently while serving the frontend interface smoothly. +The installation files for deployment are zipped and available on GitLab. You can download them from the following location: +``` +https://gitlab.fi.muni.cz/inject/inject-docs +``` +These files include all necessary configuration files, scripts, and the .env file needed for deployment. + {% include-markdown "../../files-from-repos/nginx-README.md" %} -## Manual Installation - -For manual installation of the frontend and backend components without Nginx integration, please refer to the [Manual Installation Guide](manual-install.md). - -# Conclusion +## Conclusion -By following the installation guide, you'll be able to successfully set up and run the INJECT Exercise Platform. If you encounter any issues or need further assistance, please check out our [FAQ](../faq.md). Additionally, if you encounter any bugs or require further assistance, don't hesitate to report them to us. The [FAQ](../faq.md) includes instructions on how to report bugs. +By following the installation guide, you'll be able to successfully set up and run the INJECT Exercise Platform. If you encounter any bugs or require further assistance, don't hesitate to report them to us. The [Report bugs](../report-bugs.md) includes instructions on how to report bugs. diff --git a/docs/tech/manual-install.md b/docs/tech/manual-install.md deleted file mode 100644 index dd7e14f..0000000 --- a/docs/tech/manual-install.md +++ /dev/null @@ -1,15 +0,0 @@ -## Frontend Installation Guide - -The frontend of the INJECT Exercise Platform is responsible for providing a user-friendly interface for interacting with exercises and educational content. This guide will walk you through the necessary steps to set up the frontend environment, install dependencies, and deploy the frontend application. - -{% - include-markdown "../../files-from-repos/front-README.md" -%} - -## Backend Installation Guide - -The backend of the INJECT Exercise Platform handles data management, authentication, and running the INJECT Exercise Platform. This guide provides detailed steps for installing dependencies, configuring the backend, and deploying the backend server. - -{% - include-markdown "../../files-from-repos/back-README.md" -%} \ No newline at end of file diff --git a/files-from-repos/deployment-files.zip b/files-from-repos/deployment-files.zip new file mode 100644 index 0000000000000000000000000000000000000000..351e01d504e88760eed517bec66f2940a15525c4 GIT binary patch literal 8293 zcmbW72{hDS`@qLevJ<k6HDbm(NcJuJzLV@rjL{hTzVF$kEJ<Wnc3BdN5g|l&i7aEM zq{x5z^?Tpa`+IBN|IE2_zH`o;`+4qj@AKSe869;T+%tf0FLKLflfNGR{$K?#0vzBl zH-x>L9lssS*2Nyq@8;<2<^!^`cXx&PLhaoU{DuZZ02~;ezJoh@c=`|nuy9v!0D!+f zbkI{%qbDQ$YieC@NX%XIw-fY`#ANF4EL(dx!Ul!_+rr!&zzBP&yQ?+A{&!Spk|1%X z0D0uWQ5=JX3ocWH7AYQq?hvUPXH+>zlRq`*rOxi$YqPo-Sj)kax0lzG-zcysJr4-C zd@9U*HQG(m@&?lT$|Ezrk$dsjU&9}KOu$7ceJ-8VkSkNlvR{_GyeZaV<1fBc`YG~_ zs0y>Isg|g1{lX+A(pT0tHOduOiinS`N*7cyPN#~Ndt-(_!E-@@Q1AY`_@#&XjO{UG z-<0x0-@P~wE&0$2`8EVGQHrCzn>`$@0nj(SfIXakr-|=-2DF7i-C-W~K#&6v%>TDK zL4VH!gM)pcu0T)s(|a|@(R{BDEs_*A03eKsSl>~gzfs@j{GDJ$x_$6YfwQf9G@r4e z-EEJA6R6@1IFa<KMEhH)_qy^Im`JDVT88~Nd0)sv%I2_gIICHE?w${M<)#XjU<E8_ zSG;_=--#WO8CD=o2sm(oq$0akH9%kxX`DtP(B@Xle)=a?qkB&@?oX4?T?nnZCnqBe z6)>36SpB*fK$EX-Q~uU=HEAg(YV@PAh3fMslHwb@keb;c`)GNYBk2c>#zG>8Yn0VA zH(K<E+j(VjQHS^*OV>cVW8R>_jWMt}sjidkjt<dt{C2F<dZX(R<5ENG?LK-)V4}Cb z6$V1v859JCxxwJ}?yx_pk5>zHu}?z_)UcqZqr&@QkXQAkI#x9eb*h@MN4^GLq+POx zQfx+8UY<0$oRa=-TCINku#ksdCAG!8YrdTxTe3oeoKB?AOB}#y>8XO5^LDTR0A2zN zrT=cBP6&j%2j=!UV;}{a5+I-Xz$;FNJf~JqAa*B=O*X0kZ<2aNS!cA=K{JI<X0$2v zt3Quv4X1IY3sB!pu;2e+bN`c%PAKAB+vuzAONo|j)CGm-L3d7`p;)5chn&+;CF;My zN#^M9N_B~PlsLLs!%t;;8pxHtp|wU>-)?E{7?QanW@l6lYQnmOrynXuPqHl3Zr*ca z+W1QNQT5Z1J>>$!Rz~kb0`4YH;429&?K>2zecQ2Qb9b4a1T>$hFv|o7s@>O5*0%=6 z8|a>e%L`7%gl*@)vMRIB$yZkKkKVDlUtv!7X{keEfkb9NcQD9W?9=sn#j!Y-;>Ium zft$3F31<kyZB0UIfww1|qwyXBlKO7EjkIETu~Zo)B-NwT@aT(-G}MRYsec2}PSX*6 ze`M+VCbdT&ZrewpM8z@<89ubK-!Yqdao#}6$0>><ciw4(X|Yx_ZBg`gr-{2APRA=Q z#z67b5N44bZg5Qiig{2_nGB?Ki;y`yc8J^TnkK}}j;(F(BW_1K+#N?#prh*ykTa0$ z_6r5Euf;6<v3-a$Qwu`Zs5=6sBz+ra^8~hvR}|T9-pUUU`|`!djOTXJ4aa-d!Tk!T zJ<*nx(zm;-@s=G5$1_Q=fF};~&8Uqrza>BaepMgcmQHT^2E(roxF~OrW7^Y)Y=`Lz zqdNM4-6aPAE@EOLdP;JNno3}(-M>A`x9jGYtH#s#Dr`!WI`H5ja0pvnpvUx;^jSRY z{=^wkg>&8wwI4wRoRbdhDd$xuc7l!v+6ozYJXt7_M@@H^^ZXChGz_jzDimpuJ9;xf z^9BgQvs+|}$JOs8CM(?wZ&1!;GpSBxW_i9x(sGU^7b16CUgan-`H($u*(7a}dpTM@ z`dVvpQ6tB_hFO$h=}HSx^XLf=Yvj1$)wOyfC1anW&arbg#YI^rNY8~yBl3J@o5!!8 z%*a@NWOFq%e!2#P7uyXvuqV98I2dM%Fb*}cG6mJ&=daeYewcn~gE+AEkdN35X<6&6 zwu<}FrTpG?Xm0YQQlPzH(EW~(jr|5!?kH-Shk@JF4UO$jRuxx|bw50MeVICkWas%r zakzL|p|@r<cueR5=YXi(V~>U{v&Y*V_)e0m*p&20N^T33<~xpT_S^z15eO%Hqv311 z+%APzS=b#n-PjB()4I47J#rG?$ScGqu)eseeqf#p<6-t+JwtbOd|*r~&7$}#l=|?Y z2#2_yzsNxXTayv%Tq;cZ>9ZVgyga@y_|b$!*9GgFaG~W<y)l>JK<Ne93RjhG-)db# z7=l*rq}3wGG=|YJ<d!5?TBibG{R2r^S4&a695$xJTMV5060C2&Jm@4%m^EXe%j6@I zgVn=xGLQ_*gu#oEabcH%iOC80^z~cWwb$hh9D!P*9Y!YL{Dq9HJGshrbQ70jV+s-^ zDcy*oE;J}!y|~J=hN45cMtIQEkikE5SSM4uBnJ1o7VB6@n2f5(bERJ8HjvbjAImdh z?;GCaAxlj1qkO>4TXZ(Y4ni3&mucTbCi7?mj}(z2M**qPWAtvOr@#xnyo5gj>svi? z3;43_+hAhpymxiU+F;Tm6Om-2@1)%wv-8P;@DpWLuS%-jD3$a_qx2FH?T<WNj-D!# z2kv4FbNn*b@Wx9zWW@TMTeh1Uwf)5R>Jb7EaW2MK5g1gzfOPUY8_TX<8dgNr3NDYE zT>LgR(3hL65^wQMmyghGZQA(Ng*DH?cTQB+ApH5_mTR=e{wH5|Yl7#6B8m+wa@9>y zeKXnWa}@!b2u%S-i^2Et(K{O(>nOyoK=xcf^J8-hs6t6_vLc1mGUfE$co&skTK{y< z7T*-nN(QDfxVuy?zf6B7*+_f0Sfg=wncCWJl71-%UTgf*+hOi_i>wdB#sU}wGO4;= zUHdGQ-EOfkKg<7MPak!yJO26jM8K{MOt39mV;QPeg?xmYJ?tjhFOf-CV|3{?c${K@ zgTAp=yX|tM8H7Q1Vu601hrM#FcfafS!V??H-6<|ZllNg(3`5s#b#7QPy0SAT&V;*$ z%6wL`unZ{_3%|U$#jqI2I5!7oc|X#=Rcs*=>31HAqens3?^wG;^MXsqniQWHj+>E} z2E1?3k%6rO+b6Y{OSKG>mdG?=bxG<{Jh1W<FFO{6SdUJ=t1cJfgiHC{Q0C|$Nj4hq zaWD*L@`%!Nb*jrgv&<KHW<4mJSuOn>{qCDrNjX%9QX6G#HT6PILiH`mT;m{3FV3zj zte-rCmB!;{Po=J_j^b`g_m!L%s@@B04-loEnC*#dJDBiY9F1ec&1(d!Q0dij8h0d* zLTW7q?RgN-47cADS255MZwJ{diNx0%#Ic2ojOPc^6}&cHM>xjCGlkM#zCT3P2HZ?M z5~WHxGYNjwz`3r{CJoJ?%sKCYO21xQEvaSuMoLF3DY0GNddQL}pMywH)@6g7)y3cr z>#*eG;pzc%-|4i0ny`9{LPMLB^&>~0a3Hlc<^DTKv2_xUTxZV7B^tQlBWp*~VQ(x~ zBU&w}4%;Sqy|=mX)MJ|`x^&j4$4%N~Ry4{)cf;<eD`Y&M0ruqAbjT(US(BAI@2)WD zn%b6%)l#%xE6KeGWfGnemsq>cTckk|<P~9Z7-qT@Njp<Yk_^<q!bxC!P)4ZY#sB5F zF@Z^~qN;g`mcCrZJoPPGyqU8jwSf}3(L~Af^#TI3i%`0R($0~<H+$IQU5L^l6r`gv zb*}PVO5*WMpVz)(g!9m-)^mEmD5v+@==!*XzWaJe>#UpF$PT%7fa#aLumP{W3m2Ey zo>^Ji-bAUYzs^Vm>xcKx6OmwvxN%Cj5(8BWHLiRP>}5>Z01DkiSO~_TUXs<lS$a|- zqf8#_d4=F};B{)G&8M5}>Ux$qDWx)v6{@f{3TDSx4toCnB;Y0lBIrllO}Lc$K9ZD* zce!G3`z@+rgRYHd#*<QT@mSo5z|gxy8rg#cZ6B#F`LNV0(w2viyessqQECbf+E&gY z|4Jps0pAztbn)A3v(jevBMiON$)T`jnW{&@LawqIYo^iQu4+3(s&-E168)fJ_|BL- zJfpXC>cZxph}cLA7VC#nNy1Ol%Sz_nz=*2ZAkFT)c-bN07~WZrUL4A;*|tQ^%Wo;N zcN4A8@|#aFH3#pG#TaPSbR;QGIgI;?+qLaTye$$AR@gc@eO(vd)a=?v$AmZ0NgXF9 z*EQJQ&FkMc^*<zqp8A?e*#hKkd%Vh%Qf}dXl@SJ_O++-2)GD=Nc2BXq6BF01(~iDO za+JLA@((}sfz4*`;Lt_kKcH9<zYe*sl_K}>teS*?_(hU8!YY@+gAE4lf*UEfQWu@G z45li$alpZ~_{Q=OgC^-g|By@uGh%#eI++d*2FO{Bg#?a?iJ%;6Lhx-YgQtrYeXrt2 zw(PDNIiK6?gNFFo%sy=5P@mrcZ}~8?Bp6KT>RztPW6QGCEQq{w$=N7tWQcGRKfk6e z*8Q0U+en?9Q~H=ucoQF$xV0gj(j}fVdbmm6aSw%|eQ<BceEWm~MNU8MTs!~v!>B{V z;@2t1IgNT}5tbC*)ymq|l1`3ZQjW43$=PSl6#FsnWVp4C`4XHfXykheU!yO{w^1Fj zw(T4;GpTA1!QtCu9Q=1{YuIEu#fb`SaF!NOS6mRd9%Fa7%)ys+t~Bbq3)W^q-dR*O zk!{o*1v-g(T}wW?{|U?&r;vGN3y!DCp309RoVIFAqbNg78+hHK?nj;vS|nk7Y}N2S zD#b3lB`@=}K0)~P6J~GCY~ym6bs};vNVpL>^_t!6+#YTvwsV^@1kxtu(vc7ve`nsX zj4Ee(<FQN`D87ct^7_Gn&CZj^FNGEGT@UT|1S2(jWmj6_T;%fX?XB*f^$Y$b&9J)> zMQ@ExkQ)DANfO-N(b)q5_x)3nRMcNh5+QI__EjEFD}abZvq7+1G0KXg2Y6$IW#t)2 z_8|M@;uPyM2n3J@U8{IE1E{fik89dGPtHYzs-j#;`&_kEu+qPnQiY>5VfK#i^+rN) zQNG8AzVpeM<Llu^qx`4s1gL0{A%wP*N_567iiw^4V<P@L!>QD*c0<=SX1>rcn=t8T zV41GTma9}M#w!XV;uAcu%47L!_*D<T+~JUo6B2sUd~kHMdAQyIQ4YUFmN3y)-Ci6f zs9z?94CSE?Ext)GRrr`E-&nBQl)8k}U<G;YaLEF^Oj~Cn+51Rh+DiA9K&rCMS7cz@ zo?Qvoe23sJ0guqA%se)Scg2uNT#a*4SBmki+b-^P3UMNnl5E`NBkYBM;kNua*v*r} zv!n%3b5^DM7RI@ztCK_<y;}QM&j87cq8A-^fNOKPa(JS9Jd-HKW|en4*Ic8s?<Zx^ zEzICVBTX`2I0RDGJx{qY+d05GT)&V}(6tBcawjbk!pm;!o?5g|E8OW>3uJPt_Xgw) zMNhItOR}WrEU$>T6Pz=naqo86@uq~y7^C)~dl^T+<mN?6G1UR+BUgeR5KMMRKoI2N zY2$%#MtGv@Eois)hjI(FulfvngF@a)Y2PSFt~|hI6Q^c;7Pc|Zr7AuZ{*kS>h;X6B zJooa+N#l%FFOd{+YJW0;E%#XpSMva)u>w9RzF7VASVe2E*jyGK9AcHh-7@*~D@7tw zSBmXk!k6#jxA>1YRz0!2x%{Qnxg{x53h4Z_y^Dq<`omk|(}z*GhQ2=)eHf?l000q8 zmikvB|G%X09a`bCXdh1F;WV5b;#aa{r;)~-z-2}S%f@@)1zKO&)GH@B*#t*oXEZo3 z^gbqcn0-P&D|yZsSs$kPmalHW>Rm`|x`V)@EsnuijzkLllzB$>m$-9F4JHhN1I~F) zB^NuY1Q_Mh2@UPf5WH~A;{l~S*p9tN`HIprUj3fMy@=#Hl1V-6gL`WuTII8h$t51W zZzo&Uybkd+vWAh?i+KJo35$8;+1T#zMGOmMwGMD;lQkaLef}g#oD<a{TY)<-^wn+D z-MM=@W2;QkAjQtq)aCpnvd|<rCE+5T(NHyNQ~EQZ>QI;NW|u~}E7eKoRu}iEU8n=z zaN(vGZ@HY5xn%FI9<(L)rZBd+l0bc`myMO-ri-gR8>I}~01}E_u1vtd+3%BCh|rX$ z$aY(AVIDjf&L=Zp=nRk+>#KVEb;;>*Pit-gWvo+X0kV7o)*4jgGyR+?;(QlN^touL z*RcLZdy(`$0dtx6+{~vPVbFLktZ|rkdFowO#D)57^^TWq<R=Urack%Kf`0L^{ywEk z(&%G;4L!s#+5dl)p}d_DPN46H;SVLepKDM^^}+sffFL#Xi(L;j57q);etCW|S>|i? zfkE{Vba4uVROM5xAJzt`MyXh3fL{>&BCgtsr?(PXR7XrL^Lzan^p~{Xt53f#gkJ4c zCk+9fReDv4z!}usNs`ajD_EaZp}W+&?C0gE1Gk9u2P*EWKU&KA@ELKT03I1-(7bvy z*kYorUL=Kd7#?Sl-~Pql^RTnPebMqxqKDM~PsO0`qW?kB&_p>>Y(YY$gS;?e4O8** zSqF}iG=!Q$_3J5AdX`24F*5w*&|s{Aa@+?S*$9#G25=V`F=26KEqfe|W@Q)lbQ1{9 zi|1@Q6yc`^kaU}?#@|pBg-?7*s(`Do8nwh&Z!xhqC=moU>V9F_VvhdGS#3B__;BI9 z*lCx-kc=ZNk6!DyiyNb|&G$X}gUeL!)gI6S>8T71f{^@LhC`bADp>I=@=E&`Jv?L! zbgJCUbc3qgbg%n4+)&l!Y_{`tP>pi4^mDMpGkH)aD<_7BK1o>E%s4*^>S*!){bB{s z{ryZ1IF|eNh(S98?|VDrm-^Co%ztZUe8-?2E}$;d923lMTN}TV;KxEwcMg6?a2)E6 z7UYi${m(wa@321>e!4U816vnLfR23ri2bKN0cPOSrS+e|GU(LgkKliKIP?#HEwp3C zKV2OEnSYE4|2L&_%=oA4ra$v-@G)5bPgPXRc&8J;pLrCd81TNQftaCACj>vE?9fHx z|7~kerw5qvPsi>*^Dj|g!vEf(Jl#?=G{B5~Ix79aJ`SCt#DM+JF)C*0(^29NbX{mS z6$a>kj2ST_pN>yXk!dg>|I3ztjaD#&pN=+uz>h;c&tU-n=hy=?^y#4C2f8klhZY0$ vf3ExI5CSt1PT%7{L^uwmM}PUFt^IVX|2G~U+8v?)On`nTquV^~e<A)4^6RJM literal 0 HcmV?d00001 diff --git a/mkdocs.yml b/mkdocs.yml index f215df5..cd82b3a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,7 +17,6 @@ nav: - Technical documentation: - Installation: - Installation: tech/installation.md - - Manual installation: tech/manual-install.md - System architecture: - Overview: tech/architecture/overview.md - Definition documentation: tech/architecture/definitions.md diff --git a/utilities.sh b/utilities.sh index 987570a..8fc14c9 100755 --- a/utilities.sh +++ b/utilities.sh @@ -8,5 +8,4 @@ cp ./backend/definitions/README.md ./docs/tech/architecture/definitions.md cp ./backend/CHANGELOG.md ./docs/tech/architecture/CHANGELOG.md cp ./backend/openapi.yml ./docs/tech/api/openapi.yml cp ./frontend/docker/nginx-deployment/README.md ./files-from-repos/nginx-README.md -cp ./frontend/INSTALLATION.md ./files-from-repos/front-README.md -cp ./backend/INSTALLATION.md ./files-from-repos/back-README.md \ No newline at end of file +zip -r ./files-from-repos/deployment-files.zip ./frontend/docker/nginx-deployment/ \ No newline at end of file -- GitLab