From ca8926d86ce96864874be397a6cca43373e7ad64 Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Sun, 23 Feb 2025 15:21:30 -0500 Subject: [PATCH] misc fixes --- .trunk/trunk.yaml | 1 - docs/Getting-Started/Quick-Start-Guide.md | 46 +++++++++++----------- docs/img/favicon.ico | Bin 15406 -> 0 bytes 3 files changed, 24 insertions(+), 23 deletions(-) delete mode 100644 docs/img/favicon.ico diff --git a/.trunk/trunk.yaml b/.trunk/trunk.yaml index 008810f..ab8eab4 100644 --- a/.trunk/trunk.yaml +++ b/.trunk/trunk.yaml @@ -23,7 +23,6 @@ lint: - prettier@3.5.1 - trufflehog@3.88.12 actions: - disabled: enabled: - trunk-announce - trunk-fmt-pre-commit diff --git a/docs/Getting-Started/Quick-Start-Guide.md b/docs/Getting-Started/Quick-Start-Guide.md index 0e690d6..62967b6 100644 --- a/docs/Getting-Started/Quick-Start-Guide.md +++ b/docs/Getting-Started/Quick-Start-Guide.md @@ -1,3 +1,5 @@ + + This quick start guide will help you get a RomM instance up and running. It is split into 3 parts: - Prepare @@ -45,6 +47,7 @@ Then copy the output and save it to the `ROMM_AUTH_SECRET_KEY` variable in the d Now that we have everything gathered, we can begin getting your instance set up! + 1. Download a copy of the latest [docker-compose.example.yml](https://github.com/rommapp/romm/blob/release/examples/docker-compose.example.yml) file from GitHub 2. Edit the file and modify the following values to configure the database - `MYSQL_ROOT_PASSWORD`: Sets the root password of the database. Use a unique and secure password (_use a password generator for simplicity_) @@ -61,35 +64,33 @@ Now that we have everything gathered, we can begin getting your instance set up! - `/path/to/config`: Path to the directory where you will store the config.yml 5. Save the file as _docker-compose.yml_ instead of _docker-compose.example.yml_. It should look something like this: - -???+ example "Example Docker Compose" - ``` yaml - --8<-- "quick-start.docker-compose.yml" - ``` + + ???+ example "Example Docker Compose" + ``` yaml + --8<-- "quick-start.docker-compose.yml" + ``` 6. Open the terminal and navigate to the directory containing the docker-compose file -7. Run `docker compose up -d` to kick off the docker pull. You will see it pull the container and set up the volumes and network: - -```asciinema-player -{ - "file": "resources/asciinema/quick-start-docker-compose.cast", - "title": "RomM docker compose install", - "preload": true, - "loop": true, - "auto_play": true, - "cols": 140, - "rows": 30, - "fit": "width", - "terminal_font_size": "small", - "terminal_line_height": "1.2", - "terminal_font_family": "Roboto Mono, Monaco, Consolas, monospace" -} +7. Run `docker compose up -d` to kick off the docker pull. You will see it pull the container and set up the volumes and network:```asciinema-player + { + "file": "resources/asciinema/quick-start-docker-compose.cast", + "title": "RomM docker compose install", + "preload": true, + "loop": true, + "auto_play": true, + "cols": 140, + "rows": 30, + "fit": "width", + "terminal_font_size": "small", + "terminal_line_height": "1.2", + "terminal_font_family": "Roboto Mono, Monaco, Consolas, monospace" + } ``` - 8. Run `docker ps -f name=romm` to verify that the containers are running 9. Open a web browser and navigate to `http://localhost:8080`, where you should be greeted with the RomM setup page 10. Go through the setup wizard, setting your admin username and password 11. Log in with the credentials you set in the setup flow + ## Configure @@ -119,3 +120,4 @@ This method is generally the fastest and recommended for first time setup 6. Navigate to _Library_ -> _Scan_ 7. The system will now begin scanning the rom files and applying metadata to them. You can click on any of the items that it has tagged to see the metadata it pulled without having to stop the scan 8. After the scan completes, click the RomM logo to go back to the main screen. You should see the platforms and recent games it has scanned. You are now ready to rock and RomM! +``` diff --git a/docs/img/favicon.ico b/docs/img/favicon.ico deleted file mode 100644 index 56ce4f11699ba36ba7b841e1cc4557d58f21368f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 15406 zcmeHO_j6Q765gx3Kfw3H{dVWW;V2x=#=bIOOa_w=42WctvjPH?i4p< zY$K8dhOT?% zZn<2)asAfy#1k&8+qvfa&gJUla=F^IQ$Bb2y~|aI?>cr=zi;ny9sPsL)d7ElO|XUX z9xKbgrm}+pEYMU|jYY4U*)x4U2o1#_!P-I7ApFmrwKBhbPqStfl`atFM#DITXG_1zo zrS%vCE4xz}4JogWfT*Y6fbb_(%zx6ca}0-`ucVvRxNR)*RB;q8)F4 zeq$wT@4@y|topEPANzbCXe>RT$tMg{)>`1;^2B=6@Y&FaW5@CH_M$G4&-H~Rvo=EX zt8YnqQ9pa*a%|i4K9YvVL3U{qES{DvwU2!2b@<#WpIf;$89e&T~x!^zA!ulYaE}oFaa3s8yz}i>E=LBs}_&s4!;GL8J zWxLP8h8fEsw#Q@$$MK!lz6aD7?$g>=&PWPupP2;PXD-B&1O)>pv2n=nHX6KB7lHrC zZ74`sr;Tm?s3?uAg#W>1)F@UPf}?^yF*WyR;r-6+8Kv zj}!cq0Y|yvGso#y-y6RF+*<|7UCeVzoS*#pOwPM(o{;`r*T=B~&Aa8VkJNPJa_s8L z$dycf%dTUZe8SNd443nE!m>`oL&)wVeeW4FkIDa`@ykHVuH(Y^%j-lF+FD$5xUG17 zD!UvKUmhU!t?3-ZN3S0`gUP2ka=+;-kTJ;PZe^3kl8<5cymW|uwwo^dkLI;R!@_x} z)?9u~x*O-C2WnR3!PcpZp=d%p6itkW;)w}bVejz0@0~c3`_bp%yR(v+{WbYLm32{n@h> z28;eR*+RcovW)L&t-FEzMP4iW1cPi_3@FF>*c)x9k9}7E$1bY_8V&%&HOg8OBvq~Bv>iIXVF$nYH@N%!V)-d^&+*i5Czhkw| zPmY21t|XgEhUYRwJR__Hf=oUxG0*je8+c}FQuhst{y64bj)O7qjGYIC3pYXDs7Q$K zI0TaC`yh46cHB!(fbgffLfoLa5Yu;-r5)U(qcz>twLXxC`&lPrPh;Z2wZ~uE2o=X} zgTJN;@xIIz<%_my_EyG|Js}2857Os4Ch1I>I0ho$uT98 z{w0$VCE1$&jrs@WLKwqPxHJzuW9Nf=$TTR2;yHJ42veEL(;hA$VFPm z_4$8x?N%H4Rz7E}q&K&}SQBT8^Q*M+@E>Y`&ArDHb6gx zoFy!!;kRSW_n@A?8UZz(K~$! z_z&G+XVRh!zlMwRf%K>S;ngjBZRH!!iTu3yANA~r-$QlkMq3Q|{oX;nr~AOk-@@7TLGxYMzc53UVZ|334|=crNE)NOUSr`?-yTcd75i7)%I9|YvE?p1 zL;uk9CG3t$Ht8vHl0OqSOGieqbFuB--e1kuKT&_h=88OBzIukg(+b~RzYUdm-sWKphh&3CEv*-?2kzCkShV}b;+@j}eRkG67Qpiy zojHG!dj`9Eh5wiLbWeg;w5};wLfw<_dHd7WA4{At_D$zpybpzhztY~yc%IYO7w+q+ zrhU2}eIxISc!tl?Jp=#lXRC3KMRV-fnqmic6J|Z)Ug*c}G6|m*e(L-2up8}e{Cp5j zWRybOi~Xc^T(onj=UsR|VTWJFZk8>7FY0QzpRuq5?X!-g`C#EIgRHR|&IIyZxX!Vh zfm7L@joH8am*daTRYj1}WrT!1(joW7F(Li0W1NHVe{=HcL%#2~x2>?)lSwEA@@0IyL+`G7W2g85A`R>EJwU_bSF3WSQ3*Y-$@P+zlKs)V;&4L9T zdOO5!p0h?BD3)?|t#Z%$0M|KMhnWtBds|B#^fOw>d49#Shxt2_XT%_XHrqScokk4y zcP6`n*`M&!TK=Hi44k8}`*b zY}j814f~Hk!-sWn!Mh#mRu({Q>K3&WLfwi2sno9E-+6Hj^1`8HHyl`!3;Pn+!FzL3 zAq(S0QO{s357!&(waIMnP?*K8&wfk% zw0F(z9tLTz3{>oAalaTEukNcu|CaN~c^it?5=V9W3+D^O&vl@2h%m%xt?(#w&7KoZ z@9(VowtAO`XAqimI(`MScz&Q~I;;I0TzXu6wnePa@NZV_ZN$z$OI%{}k&n0YIw)S_ zp213nfy1;15$&&?(`V5kq{M^>8wz(q_xnw6V z*qXz!K5m`f`)!6@vA=%LFX<3u92CFg+*d>z#@-sgIBvoFu2i`%^2Z5w{u_x)hOxEA zW;IWOV-)*Q##+&D9>(xaW|Rr`H?LnDXRuo2k|@jRvlE_)xOuKKLT@da6cN<2g|tmI4$VV3-`3e8uvB(t9Qm$*qpqh zwZn=_bk9z4kF4Sby!&rv_y6g67a+FZ>^AME7yoUj#2pR4L%vIQuoi8MTw2g`3Z&hIWsP?`>4(ki?OZ@w0D*o z_u=t4ibon_AR%?ZIdm#h_nTaYVE9ArDRkZByQLj>LFp| z!l1S{&Li?^%e#&;#keH?80N00hn>A;tdb6xx8@lU&hqH;G47D^Qh$i)HUZMot08^! zC$MJ2X;>QNg$VLPIESNNL>*rlW*wW={FA~RzTc#rA8vaIe^BlSnC<2|<{$df%by%f^YJ_3p*u2{AkVh2RojtQL=PiOlj z++2rX{E=*n`f2%r7P|V9y_k1+ONx1wVC;{^fw&~{o8rJ3`4=Q!t=V`6=DkMxnSJNF zA=BZC*E&`s;}I$;@mxNi zsm?6C2Jyq@e* zDqG`_OY^&oWpi1y|Ei3`EZ@Y4pK_}y7o785s+D_q)BTBr(Gic7HGp)W9O9DF!%(=? z0~G(ve{&*iiCP6k8+U+jO&L(0LkhQGs znbz3Vb*%0Dk?k+(%(>V1ZSZAQNb|aU?- zDBt&)#;J;Y8R7EnAquh%$}UsAZEpKB=3k>fPqk1Kc0KLvhE+v6B`XDo&CkFM(Y z(I-)kdC~exaO2pp{gURF$ZzV{DUa@WdZ~h6@Hd)1A^77ltjCrZh2L1M4entxpmf_w z4SzY|$J~^{#0{8NG=|-giTfpS?oz%z3X11rbQ!)+?ZFTm{+ z7qMJ`JFLd%;}@YB^VH85?ShiwGqpIirEcmR@L*0@*$3yC4&;-Ha^AyvJwa;A{SwDd zKL7nW%VnQ$*mrV0h(G-PoX5jM)ff+l>w9aUEG%5WA+HCLPMGUJIn8d&E0*5#d5$&d zz}JV^=ljB`tn#3?N8IfDw%}*60@UGJ)gdSuF^gfc;*T9xyZ4++xwr?U98zxMV6}7n z=G+S!hnv->*#A!0VKTp0#>u3wI+qFtO@>K3SpNQl*jmOFM|JE|UMZ;~A|3djpB=20wPH-b0C*$D8IbAg`mHB~xe%8cn zuE|mJqwYJ1$2H>rnLKEDJo|IG`2P}cY@N^ae?Z>8zXO*l_CWQDO>iK2Jsim?fOAFLp?*&de0BD7 z3p<D@Mo;mve|2}GtQ>fqn(D+3F=S2WHV90rDMR|{&Q+5C5*MZg(R|2>X VQu1ZWKmIjO3iG0V{d;^1{12ce=6(PG