From dbb139dfad85bd8a9c06328fc03b3082046773ae Mon Sep 17 00:00:00 2001 From: "DESKTOP-T0O5CDB\\DESK-555BD" Date: Wed, 17 Jan 2024 12:00:05 -0700 Subject: [PATCH 01/13] updated documentation. --- docs/documentation/auth.html | 59 ++++++++++++++++++++++++ docs/documentation/index.html | 61 +++++++++++++++++++++++++ docs/documentation/locale.html | 57 +++++++++++++++++++++++ docs/documentation/lubelogger_logo.png | Bin 0 -> 8262 bytes docs/documentation/share.html | 47 +++++++++++++++++++ 5 files changed, 224 insertions(+) create mode 100644 docs/documentation/auth.html create mode 100644 docs/documentation/index.html create mode 100644 docs/documentation/locale.html create mode 100644 docs/documentation/lubelogger_logo.png create mode 100644 docs/documentation/share.html diff --git a/docs/documentation/auth.html b/docs/documentation/auth.html new file mode 100644 index 00000000..1925272d --- /dev/null +++ b/docs/documentation/auth.html @@ -0,0 +1,59 @@ + + + + + LubeLogger + + + + +
+
+
+
+ +
+
+
+ Getting Started + Changing Locale/Culture + Setup Authentication/Multiple Users + Sharing Vehicles + CSV Import/Export + API +
+
+
+ Setup Authentication and Multiple Users +
+ Root User +

+ Authentication is disabled by default in LubeLogger. To enable authentication, navigate to the "Settings" tab and check "Enable Authentication".
+ A dialog will pop up prompting you to enter a Username and Password. These are the credentials for the "Root User", i.e.: the SuperUser.
+ Once you have set up your credentials, the app will you out to a Login screen, login using the credentials you just created.
+ There will now be a dropdown tab to the right of "Settings", click on it and you will see two options: "Admin Panel" and "Logout" +

+ Multiple Users +

+ Before you get started, it is highly recommended that you set up a SMTP server(though not required) as it will greatly automate the User's Registration Process.
+ If you have an SMTP server, you can set it up in LubeLogger using the variables within .env
+ To set up new users, you must first have their email address on hand as the registration process is invite-only by design.
+ Navigate to the "Admin Panel" and select "Generate New Token". A dialog will prompt you to enter the email address of the user.
+ If you have SMTP set up, there will be a switch right next to the button that says "Auto Notify(via Email)", this switch is only enabled with valid SMTP settings.
+ Enter the user's email address, and a new token will be generated and emailed to them if SMTP is set up, otherwise you will have to send it to them manually.
+ The user can then navigate to your LubeLogger instance, click the "Register" link under the "Login" button and type in their details including the token they received.
+ Note: It is important that their email address matches the email address the token is issued to, otherwise they will receive an Invalid Token error.
+ Once the user has registered their account, they will then be able to login and start adding their own vehicles
+

+
+
+
+ + + \ No newline at end of file diff --git a/docs/documentation/index.html b/docs/documentation/index.html new file mode 100644 index 00000000..926cb687 --- /dev/null +++ b/docs/documentation/index.html @@ -0,0 +1,61 @@ + + + + + LubeLogger + + + + +
+
+
+
+ +
+
+
+ Getting Started + Changing Locale/Culture + Setup Authentication/Multiple Users + Sharing Vehicles + CSV Import/Export + API +
+
+
+ Getting Started +
+ Docker +

+ The Docker container is the most reliable way of getting LubeLogger up and running.
+ To get started, you must first have Docker Desktop installed, which can be found here.
+ Once Docker is installed and Virtualization is enabled on your computer(usually at the BIOS level), navigate to LubeLogger's GitHub Repository
+ The two files that you will need to download from the repository are .env and docker-compose.yml
+ The .env file contains all of the environment variables LubeLogger uses such as Culture and SMTP setup.
+ The docker-compose.yml file contains instructions that tells Docker how to build the container.
+
+ To pull(download) the pre-built Docker image and run it, you just have run the following commands:
+ + docker pull ghcr.io/hargata/lubelogger:latest
+ docker-compose up +

+ LubeLogger's server instance will be started on the default http://localhost:8080 and you can navigate to it to continue setting it up. +

+ No Virtualization Solutions +

+ Starting 1.0.2 all distribution of LubeLogger is done exclusively through Docker images.
+ Pre-compiled standalone executables for Windows/Mac/Linux can be be requested, contact us for more information. +

+
+
+
+ + + \ No newline at end of file diff --git a/docs/documentation/locale.html b/docs/documentation/locale.html new file mode 100644 index 00000000..0d978b60 --- /dev/null +++ b/docs/documentation/locale.html @@ -0,0 +1,57 @@ + + + + + LubeLogger + + + + +
+
+
+
+ +
+
+
+ Getting Started + Changing Locale/Culture + Setup Authentication/Multiple Users + Sharing Vehicles + CSV Import/Export + API +
+
+
+ Changing Locale +
+

+ The culture/locale for LubeLogger is configured in the .env file +
+ You should see the following when you open up the .env file in Notepad

+ + LC_ALL=en_US.UTF-8
+ LANG=en_US.UTF-8 +

+ All you have to do is change en_US to any culture you'd like such as de_DE
+ Re-build the container and LubeLogger should start displaying currencies and date formats in your culture. +

+ Important Note +

+ If you have already set up LubeLogger in en_US culture and have inputted data in it before switching over a culture that uses "," for decimals
+ you will most likely run into issues where existing data in the system gets returned as thousands.
+ The culture should stay consistent for as long as you plan to use LubeLogger. +

+
+
+
+ + + \ No newline at end of file diff --git a/docs/documentation/lubelogger_logo.png b/docs/documentation/lubelogger_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..b3713e8067a37d3e7a04f8d777add1d4c4c27d1b GIT binary patch literal 8262 zcmV-MAi3X(P)I>00001b5ch_0Itp) z=>Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>DAKOVpK~#8N?Oh3c z6h-!~o+C546B2TekN_SaUVubV!YYCnf`TaGq5`gnpr9!00pbN7tcobBhzO`CceoJ* z1SAnb5cw-0B8Lef2RX<^j=B2(zMAfFX1aQksO;)*=llIC-Bo=|cU8UjzW1uC!-5DR zh^9kQw!a(pob(;Exze4}V7ECl_i|-Fh#>y5FeuyK1rnB)w7J5a(?XWzjI>1KcS<&h zApWxWLj;Db5+7nXg9zeJiGUqc>A>$%I(BM(>IBML z_yI3anVB{>V1M0Lwb-o1A1|!KpWYc(7HX0D@e(i4^&ynT((bYP26@h;`=U+mBS8f5 z=Yy`mcnQl0N^!A~#+NE;hb}5^DjzK2anraxkXMC`v?rtvJ*DDd>|ss zz+M>@)92vARu`Zg_n>qa?fyvVElMq|7HQb!9W6fug(iqUD}(~$Ei872?0D*((`^4S z8;g!Gv2PPN_F zH$pZV`Lzcg85H?}dVJ062|osfCWt>9e8yp@qar_x61Ob<{&~vu#qRn#%HK)}R>9aZ z)^Ps=w?@7i6KRNf?UPD&>a?q#%9l`DL}@D}e(jQG<578kpqj$ou;>!RI_@U ze3Htar}QBu$6MoKpB&yd;?+=#fo<4Xcj&`)H5X-Vt>s*=Igq!eTOB6WP09MeWOf{p zx}D5dvVR!lohhjfyXjmd>j7zl`j8&EJC*EN1-*9+y>}-i>jRU+wqNR5SgK@$_zmz8 z7=VOkGi`d!T~p0QPA&Hq7H@=78bc|G(o{;tl$wJCN>5QbMG5{3e#e9TpSD`pKHc1B z`@VYC>*3w{?vE5<(gP9={0p+aNJPM~1CN!O0SP zPMZM*|D@fsE;RHEkJ2-|sbqa{*QDY>%eK}-sRf1RH$o&ZU1eF`-C$#^+lazN2aeg{ znE%H>zn?;zpXnJwGe;J&Zw}hFQ~qjxuo=+nyeEnstldBuHP(Yt4tD+sz@pjBtb{5w zLMifK=!+$6!NywnaRb~XXAe|=*|f=Y=YB=b|JAde4{^QLn$jO`UH@00ar(`fxqFJr zoExnci9LQ-)E!iW3jR+5^elAc_BtmC3#`f$ytEmRx3-L6l6qd;gDTJZU{GC z)5S7FDL(5U?bwkv!(A@fHSxXEM%qUw+l6Dzfzuq?Ut$t`CJmI1vy5l{K*$mssOE4v!3a4U)?39X#dK2qM5o+PhM4pWMPP@th?Do(6Qou3qE zynEe_TDkudC79OogZqdW)Y;q62J{V7N3}{PD1jm@BFlB0mjnRa1AayS*{iDM(XW-m z(Z7%qLf6fLEhlXS2~2+_>wz8}1AQZll&WMsAWHX+xqIF+TXx!bswqC3!5j1&IrLtW z8lz*?wXW=}R};!es=CrWQ^^}ULfvw+$&oik>d73+sUFyJT6d*;525pJBtdKg;g^|Q zPx&HAlGZv5&bLCZ%BOqy!k(S>9X+(h;ctwN$y<}-?IzO@y7ypNmM)=Z^au*+t|JB} zEjIVadqyep0S_{m*+eGGePu}^3n!P-b8a&`q){x?5n*>2=PRdrAj#4ZbB|n%?{V0& zTW2!K@FeXbNE0J5d5?>+IhM@44;pgP?x%Vk!cX*q+BQm-qai1~6IlSI-sE%L^+xq8 z%lWjw*+unc>7I|F4-e$6%w#vGt)X45f|aGG%?{fUyD8*u`n`cBljAO3fuYWehZ*?J zvMToI^wSuO)Qr*tbY3)VUZXUek}wQR{)nrr(zPT$#`qw0uu7#^1G?9A+B~v~D9r5> zN)WAkkRNCUK*#LnQ0lx|3-iW;O7_&d73eS?nh6?Xav6VCvOefMv|!i%qxRQHpx)#i z-49Q_TmI7<3#ymex2J!r7hqVlsfG={P9sMg3qG&;cIf0XbP|uy*t650Cn1?g4Wk=U zueZte^*heoJLs7*L?$@`y~o&TWo+j18Yl=T3LiMK+YEIv`E`1~c%?{)ydpfEu@$`ME!LCWYE64c4= zBfeOjUAw$rkFe`Sib!o6+Fb^LcbGz6Aq{rF`=}UBl76DcBL_WG`hijeCDWUv&p)We zN-G_p0K}QV-0gSnSq35a8bE4clB!t7xRn7c$tT@GegA99qY1iYg=)DJ?bLnRO-ivvG7f8^di9c*iSb(%7Q}T?DZ4k(C zu_}VV*Er}vw0X|q=jeb*v-`5is;Fca?w~2&BZ5!;8g-ddn%-M|z3t%)z zhRjY@L|uEkO91IkWyc3}|Bxk9;=4dtke|M|iuXs2z>pBYaeRT2F>7nBR8;0{p#7I| z%o~bj*+}X9gU4+Rm)=ugxc9|U2VL{&4@d2TC|yeXmkxcgY|u5Mi`MKrY?G5(7^6F+ zo4*~{GfXHnWPMIG*yJpOL1O0j-0Tw?~mBAi;m_2HHh$h z#n;(4;OcN;gzn4l>RD-(?6~hH>n6Pb1AY^YtB0c}xnW5Kr9-2Wpx?+3C_ral`&BL9 z`lDT{*^m-%{8-8AzK8mpwCkfN964!s%LWE2;sa_+mc36rl-4fAgxTg3v2Qnp-7lhl zc-9R&#m@|=?GPVDKApsb{&8WMgYEfIzuwfgAv*Po!z7cEkvi}LUf8_5PWTKhV~p(b zjv-624?0H5PD9;+Yr2H8#1S+!3|8W=q;}dagGp^`wM}p1OdRrmo|qJ$}XFFZc_C_v1M^zq4 z{wZg*Qse`piM6FoQlR%xpOcbj>;--YDV7=3xIUJw4J_% zcX@;t`r+}n%UQqiC63e8d_Y?RwH*rAr?n-4(G2pQu6D96_Y|xO@ zKO+*_w-#5jo5r1Dhx2Sg`tNYcF|_IGFs320*{F4e513y!G7gIVJ#b*QXy zIf+`ayPq#%o4(-OERN6XU73#k;W z!m*Q1mi0=@UqlrOVOZl16)&c06y5`VSkY-${hWz$pD0B>P&Mt4-r--99^~`!{4sBB zHBlS$3{o=6{kNzk)<(@b~%1}th{NWvvhrsZP``0IxTq7pl ze8Nc7s(kV0+68t8`#T*1?eYhrVWuTt)JkMoz;lr2&Q2g)`*88ziW=7{qfufvT^Wio z9%x7(5G}LQ?@uBscUS5y`3riDDXN@0->oRjCJB5Nvjc>nP9UrRFFNKMR+X8M_p2uV z`pd&KPBMT{F*RyEr(=xy&?pu2*71(9lC-jr$E%ul-g9wRii8}L0$Od+)Tem?xwS`bSp{Q?fo-;ePMsR*OLx;MwvmHyU5LWLa3xP!c3?HA^P9q*u}c zis;~R2OB*w92QSFUZnV$AH+l$HBm`GIlgD{%Pp@GS$6!!;XDUh_)^P!QN5xskRoF} zJ6lVr!wBh^KfFWo9*#!Tf#rPPFxBZ~f1_+7C2(R`7aJvi@Q$=9yA~CLd1Shl#UI2W zxyHTfVhes70x1G|_acXr4cY!(L)xSX=X~+;`WkEmbWBSLfM4mD zxI&eVwLy=Ll~g#{_PzD&-kZa~uZ8ovezkZKru}F@z9V~daO6SKl$e^N0fd&Yhu))& z-h0e)G4mTAZLp6|RikvZtQ4OE!E(yFw+Q)XU1qP_e+N zifHf8d*qQDj zjL5(;gVx>rSTXDVK%s|@;g3gP6kvWA{0mQ*QwKaOdpM74ZA|lT4*0lAN&@G@LM`J5 z*w02sr%xLE0XGD{7YVMoAn}_pq2ffIK{@#sBmojrhYp4-#1Y)KJLQDulxn3S&-d9h@bf1 zW`Y_H5O$W|0^-yG1%Tk=zsRzrnP&zN&BSKkwHcv3d4V6)k^7ha5vEJWmTckoSV?M`;5k&!pMkDlj~Xa(){3zqPTuz~H7f-|cuQauXPK_p$?BU|KzG0yP4tm}g`h zBg=Z4ec{F$787B}(yP#=Zh_h`et3MpM(9{}AUb9-vn5njs+9ynbx7nrmJ!)KHYs3c4VX%H{)gQ|$0 zxGP%tDX#rTZ2_$=Xp+a5&`}bNK^5wQ3tHg=6B;@Ot2}QFuPzL$pzbvA2+Xmp6m-m) zly0Vk>HC4eDG~-42^hR<4sOApulMtai!gi%&@)&m^`Z1GWpmx7V%Y5_p+*8!8o)CO z$QlW?sA}>zPERZpRVd80LUR_Aum~+$Q|Z{;iE(*!4=j)H0U9l~x9^vC{1edyoVrZ! zJ-lfnFHk`56o`)H-`Oi1bNMuYu#mNK?V6kH3Zx{)4~f$CJ)npPRBvJnrbN&7>seg{ zFsN-DZaSv@4G2_npFClGsp-LgA;`*BhK3r1$`C<|iZe2-vS%iMKOiu(3(4VYoyZjr zrlPEMIOWr|+tSuiXB9d{goT*yGN@NL27!dsMg+PaUi2=yRz~QWfRF$AfX)e{1iz?^ z5@bF*N`&s8@uL zW2;nZ{hM(e?Ad7_YEn-66grLi9UG_j9zr@6zzTzoSK zAX+GJsv`RL6EQh@Ru_uR8p4*!Ophw_{<2Mvj;RsBm+y~kuTyWBMkC2v)5qws2c=J< z&bUSr!9bGtK>C1_vol8)mcB^*?b|~Q%xIwcGf90$yi&S_&d~@BU30vw(zPtaEU|x& zkGtjCuGY@VAzjb|<38xPmXFt;aUCn5Dt52w_Xm83TS%tD_8qplCeN#2SKeR9Qg6*S zj+|PK0n|DCECra)L>plx((ho?WI6_u9~)^{rB|V96sX4)5jRnf)li$J&@rWB%x^3L z*Q;y9O>~c8{%QXD8gT2$_U!a)^xk9sXZ*c=>6qOp{Jo#a;=v#K^o96xx}Szw)YZGV zK&2<@)3MdrwJgNMRvQh5+ms?7sEX);eo;ba{&<0%E4EED63eMxH9nBfc#;ksQw8er zVX=SnuQMc4b`bX0oMsucRMV%?b{lu`u({7n5Pxt=MvmhHyAIeACeN+R=yre63$K4# z#Yd-mXM|?Z=34CgBRS>G*|@`^j^RzE^sMHT4=XTp91zkgujll6Z&Ct6>!3LM`ThSE zhMD0SWKn0gIauA^4^xB_T7ilhUT;x>6cK^^Lh;M(NbP51GmejqDT zLDuN%UkV-e3)_Z-Wn5s{Td+2DISI#YlrB~h_8}Np8o-66*O+2UMYRipf|&(ApmP!b zzuo1MI6l6WrhdDy+IvMmyQ{X5_@A@>`quAB|_9F9lM~d`8rrk0n`*zApZufyz0+g( zf;zqE7`=BwtZ}toNBZb9-VRxj5r&I+fdF65OlBD!t-^Zso>oG&FT6+QrB=4@<5nru zn8M?#^|&D;ygM)O!&l#X=onV#YTi?gDqhsqxSFy7gBFwm4yg#EWF!oE)wS|^P_8j| zM1cZe*{}w;K2fsosdrCbPTa4`K%(6;#t7aHM^l|ghW()=d?8fv&Mw0WEyoKS5SHsH ziRKDns)J=sPMw@vx(V7vSfTSb@J7?6W0(U4I`-Pbv4`lHG-CwNf~w;y>vSBIj%BnDxrZ0{0dva; zdvaH%wH8?@pl|mu_Vdz|u+D8m4&lAO`l(^iuA_zwJ!hS)H(N9%&PMms^aXsFaob)V zoS8?RT{y8SR@f)$#5ohNFGAMV+I{!FSeo8_WYN+WKB#bgzO#-U zIA-Gs`_F$+!8+VoAl?6RnM9UlE?okecZ^@G1s@!0+sb4xxM$J|mldc8w8GFI*NrKf zR8ynB+_`H93(J|E+^3NW{fHVwNQF#f%|;E3tQ$Khl7AZ49}q}Hd1#lEfF#snUD}7R zoLPxha(o|FiaeOLqKd7~;Z*A-x?V^-`~iB_drZ-+gU200I%Xnb{MNYGy39+g8td{) zp`DGIint38ylinAU5jcPv=b_!D6q~*1Re_B$_2*l7swJmn4-b9y>)ylkO;84O5{p+ zl`Mug7Eg|+YIDz|_QtX;XV}av9xQsJ33Lo@LqJgbYe52oDJ!2Al{xL_-Eq=fZx8f-?diOxC)~q3^8NgC_C}qiW>L=8XBg89N!=G z%(yo|3$Wtw)Mu$nW220i!`3X!SzV2gWa;r0i5aOat&Of6^#?j`=Ey?Kqk_pFK<|k) zAi@=lB4E1wfG0}OsP7TQ8fP~%OkWXN7;k*Cp@t2gQdV)O5Js!0Rx5XcvebXYNAOKbQtnn38*ZuH>`Xm9~86Xn*_9bzsHL~bC+#> zGkQe#jOapg7sus@Hrx^hiM%jZNMr{A(XjbjS35(`X{kb2HmOls9Zg${5B=tD)bu; z{bJ*qRs@vyrA8xR0Uw)$GSUE9b_cgM0Ras?b$$iA<7qA|po?Rak8Lz6EPxu-YZq(! zzQOL|=Atp69&Q>}tj;93hXk|^t3Z*aKi=Yo2M0vH6B%aM8Xa!jH*f8k>7@NfOc)v^ zTy|}6&JC+JPV-4m|IrqJdu`U zVk7!TB6hBMNq`<)XkJB7qckSF^unofr%#L>+8;}J6~|Ho?+Vq6T#Y2^GJJB`2{e>9 zcJ8ky%Tk2Shu?(a;OogPnYsH&`#-SvP=m|=8UW7(iqds>0efavrK8@?tvmcfhu$10 ze|Sa9vZS85^<|avZTpWl@X3Gvu-RSwQ^5C4Ddm=U^X__dGDNg;_(uUH_MDm$S{NU{ zt!H@8VSOVy-E^hZV$VrC$7C{SCR1YMe)V?#`*UQ2Jk z=G3$I#RzHcj3reFw7@d)@g!^a+(QdKufBWt!Fr)~g1-ZShc(AsFcKClc}KmIJ^cN2 z4Dg|3WL>cC0{%t(6aOwJXQ}!C?IVmSR-b1H_1n|N84c33@+v3G7+yFjuh_{go&e3E zHtGi;VlFzz{D19|O=(9?+WB;I0yG0?Cm>n{hzbR*z{wc26pj1zXy4ixn-p(a5gl$Y zdfglIkYFiAGrBX)MmGKYbW^AHX=YGN5k}U0-g!iVm_14hZ_j^utZY^jByYA zvn$nnb_=ygvsxz_FKI&xDI!c_`wrXLu>y~=0|kSE^n|3zk`E*0L{5LxffbWb6nRBX zJa=b%cG_;H6P(clI{tNIiqV;2mHpelYr7QVtTxH!E-5XIthmg{4&~YLdpL%7MYI?7 zhOIaFM^@asK4=mh1N;TXfPXoGujrqtbFrsqR?M8ayn3{9n1jy2Xf8RP{A-t!iAL$t z91-YxMBLzuT7@SIf#>GQ)am-H&JdMj(=fgh5UJ4*7e4 z5H3dXF@?UV_eNw#eI8gNTvJ5pYynmq{vi^c7te{rDTO!OU$8MCl-?vDod3}4<@f+2 zo*(nZej$OGM*<^UgX0fa+>eRbjDNdarBfKl)}yb8c%sg*#qU8W1q>AZUTBo)28@bPc*%hGne3mcyK}iP-ZQq}t76NOh3q-Ug&N_{;CI|?|?_eb~Lj2!^ zMqmJcp(!YJu0F4|8EfUkuq=7@sv3zLXzBKzVGOG$ft~vsmiKtD2;TzG2n`9si?ne& zyd)&cw${q!RW8Fn`b98u{)j`%PWqjNu~B>+$6HviOcevC|4~X9gcj$tGEUFzY#p7J zU@|ARFtD0BnSaD1x6r{rKl2Kmpii(;nCUATKTGP-$+EH2c_A0aMH^TuQ7L|X5nZ3} zpz9qf6-D?M^ceU0(?KXOfVa>fFUvBfQ8*{etT57x!g-wCKHZc$tWQM0@k62|IE|g} zErfHb`T`!1!0e?>XTwbBl-y%gbt3a9(_^)x(XjKjuNPp|Mh2+ik@9SXz+hpHqS_uFYg$Fa1K-emLz-T z^IUw6xoy=KX$>S4@_DHy&0;btPodYPWyrg;x7f#{^+>xQ$pBH_^-w5zf8j%GI`W(k?8EuJ|0l{NF2+0r6rC*BMHOA zgbXq=m>nGymLUG}(4}qw2?YM{rM&j_1PF!C#|fx>4UXYIjZv1z(;Gp+-wGm#|0e#B z&Pf81Kt2vWlr6j;{GasxCs|>c6R~dH)oeio@n?sAoUj=%XXc)=IT##!A-?^|24R7P z!6Kv}f(SwZz6b)r5Tzy$egzRk5J3bHL=ZvzFM+ZD2W@a2>P1@%KmY&$07*qoM6N<$ Eg0dmvRR910 literal 0 HcmV?d00001 diff --git a/docs/documentation/share.html b/docs/documentation/share.html new file mode 100644 index 00000000..3fa6c75e --- /dev/null +++ b/docs/documentation/share.html @@ -0,0 +1,47 @@ + + + + + LubeLogger + + + + +
+
+
+
+ +
+
+
+ Getting Started + Changing Locale/Culture + Setup Authentication/Multiple Users + Sharing Vehicles + CSV Import/Export + API +
+
+
+ Sharing Vehicles +
+ Adding Collaborators to Vehicles +

+ By default, users are not able to see other user's vehicles. To share a vehicle with another user, simply click into the vehicle.
+ Make sure that you are on the "Dash" or "Dashboard" tab, and look to the bottom left where there is a little panel called "Collaborators".
+ To add a collaborator, simply click the "Add" button on the right and type in the username of the user you wish to share this vehicle with.
+ If the username is valid the user will be added as a collaborator and they can now view and edit the vehicle.
+

+
+
+
+ + + \ No newline at end of file From d68e9e9589c154499de738b3b3cb6ee780817e40 Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 16:16:38 -0700 Subject: [PATCH 02/13] Create GettingStarted.md --- docs/documentation/GettingStarted.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/documentation/GettingStarted.md diff --git a/docs/documentation/GettingStarted.md b/docs/documentation/GettingStarted.md new file mode 100644 index 00000000..9a1a3e00 --- /dev/null +++ b/docs/documentation/GettingStarted.md @@ -0,0 +1,28 @@ +# Getting Started +## Docker +The Docker Container Repository is the most reliable and up-to-date distribution channel for LubeLogger. +You need to have Docker Windows installed and Virtualization enabled(typically a BIOS setting). +You will then clone the following files onto your computer from the repository _.env_ and _docker-compose.yml_ or _docker-compose-traefik.yml_ if you're using Traefik. +In the .env file you will find the following and here are the explanations for the variables. +``` +LC_ALL=en_US.UTF-8 <- Locale and Language Settings, this will affect how numbers, currencies, and dates are formatted. +LANG=en_US.UTF-8 <- Same as above. Note that some languages don't have UTF-8 encodings. +MailConfig__EmailServer="" <- Email SMTP settings used only for configuring multiple users(to send their registration token and forgot password tokens) +MailConfig__EmailFrom="" <- Same as above. +MailConfig__UseSSL="false" <- Same as above. +MailConfig__Port=587 <- Same as above. +MailConfig__Username="" <- Same as above. +MailConfig__Password="" <- Same as above. +``` + +Once you're happy with the configuration, run the following commands to pull down the image and run container. +``` +docker pull ghcr.io/hargata/lubelogger:latest +docker-compose up +``` +By default the app will start listening at localhost:8080, this port can be configured in the docker-compose file. + +## Windows Standalone Executable +Windows Standalone executables are provided on a request basis, and will usually be included with every other release. +To run the server, you just have to double click on CarCareTracker.exe +Occassionally you might run into an issue regarding a missing folder, to fix that, just create a "config" folder where CarCareTracker.exe is located. From baab3213b5785bc0c79aba1c3a13f47596739ed8 Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 16:19:41 -0700 Subject: [PATCH 03/13] Update GettingStarted.md --- docs/documentation/GettingStarted.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/documentation/GettingStarted.md b/docs/documentation/GettingStarted.md index 9a1a3e00..c264ffab 100644 --- a/docs/documentation/GettingStarted.md +++ b/docs/documentation/GettingStarted.md @@ -26,3 +26,8 @@ By default the app will start listening at localhost:8080, this port can be conf Windows Standalone executables are provided on a request basis, and will usually be included with every other release. To run the server, you just have to double click on CarCareTracker.exe Occassionally you might run into an issue regarding a missing folder, to fix that, just create a "config" folder where CarCareTracker.exe is located. +When using this approach, the default port the app will be listening on is 5000, so you will navigate to localhost:5000 + +Whichever path you choose, once you get the app up and running, just navigate to the IP address and port the server is listening to and you should be able to see the app +![image](https://github.com/hargata/lubelog/assets/155338622/a32c40ce-271c-406b-a211-c1f2af138418) +![image](https://github.com/hargata/lubelog/assets/155338622/4e1c913c-001e-43fd-9b56-4ecffdfd4c2e) From e7449806c0df4d6fb57a595a1c957655507ba09f Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 16:36:46 -0700 Subject: [PATCH 04/13] Create Configuring.md --- docs/documentation/Configuring.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 docs/documentation/Configuring.md diff --git a/docs/documentation/Configuring.md b/docs/documentation/Configuring.md new file mode 100644 index 00000000..d179d9fc --- /dev/null +++ b/docs/documentation/Configuring.md @@ -0,0 +1,30 @@ +# Configuring LubeLogger +In order to provide the best possible user experience, we have provided ample amount of flexibility when it comes to user settings. +Upon initial launch, you are using the Root User by default without any authentication, so you will have access to all of the settings. +![image](https://github.com/hargata/lubelog/assets/155338622/cf73ff68-e79b-468d-84fb-375e481cbadd) +Most of the settings are relatively straightforward and self-explanatory. + +**Note:** If you are a user in the UK and you wish be able to input Fuel Purchases in Liters but display Fuel Mileage as Miles Per UK Gallons, you will need to enable "Use Imperial Calculation" and "Use UK MPG Calculation" + +## Enable Authentication +It is highly recommended that you secure your LubeLogger instance by enabling authentication. +To do so, simply check "Enable Authentication" and you will be prompted to enter a Username and Password +![image](https://github.com/hargata/lubelog/assets/155338622/4d8b1855-e437-4ade-999b-3dd6ea19e55f) +The credentials that you set up here are the credentials for the Root User, aka the Super Admin, and shouldn't be shared with anyone else. +Once you have entered the credentials, you will then be redirected to a Login page +![image](https://github.com/hargata/lubelog/assets/155338622/26181116-5a03-48cf-972d-89a4b1050cce) +Simply enter the credentials you have just set up and you will be logged right in +![image](https://github.com/hargata/lubelog/assets/155338622/20d9a3b9-80de-4a32-8cb6-1100dd237dbd) + +## Setting Up Multiple Users +To set up multiple users, all you have to do is click on the dropdown that has your username on it and select "Admin Panel" +![image](https://github.com/hargata/lubelog/assets/155338622/75f32408-b9f3-4e2c-bec6-ea1c196c3438) + +If you have SMTP configured correctly, the "Auto Notify(via Email) switch will be enabled and checked, otherwise it will be disabled/grayed out. +Without SMTP Configured: +![image](https://github.com/hargata/lubelog/assets/155338622/9d75ab55-afb7-4d3e-b830-3191de23695c) +With SMTP Configured: +![image](https://github.com/hargata/lubelog/assets/155338622/d9995c30-dd47-44d1-a73d-39f0f129450b) + +To generate a new user token, simply click on the "Generate User Token" button and you will be prompted with the user's email address +![image](https://github.com/hargata/lubelog/assets/155338622/f870d5cd-4d4b-480c-94ea-b1161757793f) From ac05acf96b19cc76e81a0977f152784b031916e1 Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 16:37:49 -0700 Subject: [PATCH 05/13] Update Configuring.md --- docs/documentation/Configuring.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/documentation/Configuring.md b/docs/documentation/Configuring.md index d179d9fc..d75fd06d 100644 --- a/docs/documentation/Configuring.md +++ b/docs/documentation/Configuring.md @@ -1,7 +1,9 @@ # Configuring LubeLogger In order to provide the best possible user experience, we have provided ample amount of flexibility when it comes to user settings. Upon initial launch, you are using the Root User by default without any authentication, so you will have access to all of the settings. + ![image](https://github.com/hargata/lubelog/assets/155338622/cf73ff68-e79b-468d-84fb-375e481cbadd) + Most of the settings are relatively straightforward and self-explanatory. **Note:** If you are a user in the UK and you wish be able to input Fuel Purchases in Liters but display Fuel Mileage as Miles Per UK Gallons, you will need to enable "Use Imperial Calculation" and "Use UK MPG Calculation" @@ -9,22 +11,33 @@ Most of the settings are relatively straightforward and self-explanatory. ## Enable Authentication It is highly recommended that you secure your LubeLogger instance by enabling authentication. To do so, simply check "Enable Authentication" and you will be prompted to enter a Username and Password + ![image](https://github.com/hargata/lubelog/assets/155338622/4d8b1855-e437-4ade-999b-3dd6ea19e55f) + The credentials that you set up here are the credentials for the Root User, aka the Super Admin, and shouldn't be shared with anyone else. + Once you have entered the credentials, you will then be redirected to a Login page + ![image](https://github.com/hargata/lubelog/assets/155338622/26181116-5a03-48cf-972d-89a4b1050cce) + Simply enter the credentials you have just set up and you will be logged right in + ![image](https://github.com/hargata/lubelog/assets/155338622/20d9a3b9-80de-4a32-8cb6-1100dd237dbd) ## Setting Up Multiple Users To set up multiple users, all you have to do is click on the dropdown that has your username on it and select "Admin Panel" + ![image](https://github.com/hargata/lubelog/assets/155338622/75f32408-b9f3-4e2c-bec6-ea1c196c3438) If you have SMTP configured correctly, the "Auto Notify(via Email) switch will be enabled and checked, otherwise it will be disabled/grayed out. Without SMTP Configured: + ![image](https://github.com/hargata/lubelog/assets/155338622/9d75ab55-afb7-4d3e-b830-3191de23695c) + With SMTP Configured: + ![image](https://github.com/hargata/lubelog/assets/155338622/d9995c30-dd47-44d1-a73d-39f0f129450b) To generate a new user token, simply click on the "Generate User Token" button and you will be prompted with the user's email address + ![image](https://github.com/hargata/lubelog/assets/155338622/f870d5cd-4d4b-480c-94ea-b1161757793f) From 918d086705327eafb3ffa0c3a966e4f7cc16c05e Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 16:39:40 -0700 Subject: [PATCH 06/13] Update Configuring.md --- docs/documentation/Configuring.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/documentation/Configuring.md b/docs/documentation/Configuring.md index d75fd06d..9e82dc0d 100644 --- a/docs/documentation/Configuring.md +++ b/docs/documentation/Configuring.md @@ -41,3 +41,9 @@ With SMTP Configured: To generate a new user token, simply click on the "Generate User Token" button and you will be prompted with the user's email address ![image](https://github.com/hargata/lubelog/assets/155338622/f870d5cd-4d4b-480c-94ea-b1161757793f) + +If you have SMTP Configured, the user will then receive an Email that looks similar to this: +![image](https://github.com/hargata/lubelog/assets/155338622/0d5c1adf-43d1-45a5-ad59-91fb3b1476af) + +The user can then proceed to Register for an account at your instance of LubeLogger. + From b8c0d4ef67fa4f7fbe04cda0ab6ac97eae70e876 Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 16:43:03 -0700 Subject: [PATCH 07/13] Update GettingStarted.md --- docs/documentation/GettingStarted.md | 37 ++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/documentation/GettingStarted.md b/docs/documentation/GettingStarted.md index c264ffab..3eb0f60a 100644 --- a/docs/documentation/GettingStarted.md +++ b/docs/documentation/GettingStarted.md @@ -26,8 +26,45 @@ By default the app will start listening at localhost:8080, this port can be conf Windows Standalone executables are provided on a request basis, and will usually be included with every other release. To run the server, you just have to double click on CarCareTracker.exe Occassionally you might run into an issue regarding a missing folder, to fix that, just create a "config" folder where CarCareTracker.exe is located. +If you wish to set up SMTP when using this approach, you will have to configure the environment settings in appsettings.json located in the same folder as CarCareTracker.exe +You just have to add the MailConfig section into it, but I provided the full appsettings.json anyways as an example. +``` +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*", + "UseDarkMode": false, + "EnableCsvImports": true, + "UseMPG": true, + "UseDescending": false, + "EnableAuth": false, + "HideZero": false, + "EnableAutoReminderRefresh": false, + "EnableAutoOdometerInsert": false, + "UseUKMPG": false, + "UseThreeDecimalGasCost": true, + "VisibleTabs": [ 0, 1, 4, 2, 3, 6, 5, 8 ], + "DefaultTab": 8, + "UserNameHash": "", + "UserPasswordHash": "", + "MailConfig": { + "EmailServer": "", + "EmailFrom": "", + "UseSSL": true, + "Port": 587, + "Username": "", + "Password": "" + } +} + +``` When using this approach, the default port the app will be listening on is 5000, so you will navigate to localhost:5000 +## Test that It Works Whichever path you choose, once you get the app up and running, just navigate to the IP address and port the server is listening to and you should be able to see the app ![image](https://github.com/hargata/lubelog/assets/155338622/a32c40ce-271c-406b-a211-c1f2af138418) ![image](https://github.com/hargata/lubelog/assets/155338622/4e1c913c-001e-43fd-9b56-4ecffdfd4c2e) From 399d0d8058a77fcbfa66923f6a46f072febaab2f Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 16:43:52 -0700 Subject: [PATCH 08/13] Update GettingStarted.md --- docs/documentation/GettingStarted.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/documentation/GettingStarted.md b/docs/documentation/GettingStarted.md index 3eb0f60a..0766bd39 100644 --- a/docs/documentation/GettingStarted.md +++ b/docs/documentation/GettingStarted.md @@ -2,7 +2,9 @@ ## Docker The Docker Container Repository is the most reliable and up-to-date distribution channel for LubeLogger. You need to have Docker Windows installed and Virtualization enabled(typically a BIOS setting). + You will then clone the following files onto your computer from the repository _.env_ and _docker-compose.yml_ or _docker-compose-traefik.yml_ if you're using Traefik. + In the .env file you will find the following and here are the explanations for the variables. ``` LC_ALL=en_US.UTF-8 <- Locale and Language Settings, this will affect how numbers, currencies, and dates are formatted. @@ -24,8 +26,11 @@ By default the app will start listening at localhost:8080, this port can be conf ## Windows Standalone Executable Windows Standalone executables are provided on a request basis, and will usually be included with every other release. + To run the server, you just have to double click on CarCareTracker.exe + Occassionally you might run into an issue regarding a missing folder, to fix that, just create a "config" folder where CarCareTracker.exe is located. + If you wish to set up SMTP when using this approach, you will have to configure the environment settings in appsettings.json located in the same folder as CarCareTracker.exe You just have to add the MailConfig section into it, but I provided the full appsettings.json anyways as an example. ``` From 3017db5f866e1cedfb24d67ee6a0db249144930e Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 16:45:34 -0700 Subject: [PATCH 09/13] Update Configuring.md --- docs/documentation/Configuring.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/documentation/Configuring.md b/docs/documentation/Configuring.md index 9e82dc0d..64457a25 100644 --- a/docs/documentation/Configuring.md +++ b/docs/documentation/Configuring.md @@ -8,6 +8,8 @@ Most of the settings are relatively straightforward and self-explanatory. **Note:** If you are a user in the UK and you wish be able to input Fuel Purchases in Liters but display Fuel Mileage as Miles Per UK Gallons, you will need to enable "Use Imperial Calculation" and "Use UK MPG Calculation" +**Note:** When making changes to Settings as a root user, your settings will be saved and served up as the default server settings for any new users that sign up. + ## Enable Authentication It is highly recommended that you secure your LubeLogger instance by enabling authentication. To do so, simply check "Enable Authentication" and you will be prompted to enter a Username and Password From 147a1b03a7ad867182c612faa1dcdc0c5f7fe6d4 Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 16:57:02 -0700 Subject: [PATCH 10/13] Create Registration.md --- docs/documentation/Registration.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/documentation/Registration.md diff --git a/docs/documentation/Registration.md b/docs/documentation/Registration.md new file mode 100644 index 00000000..3e18c50c --- /dev/null +++ b/docs/documentation/Registration.md @@ -0,0 +1,22 @@ +# Registration +Once they user have receive an email containing their LubeLogger token(pictured below), they can then register for an account. + +![image](https://github.com/hargata/lubelog/assets/155338622/80ef7208-bfaa-4cab-ba0e-c0a3ed6f255e) + +They can do so by navigating to your LubeLogger instance and clicking on the "Register" link. + +![image](https://github.com/hargata/lubelog/assets/155338622/99c1538d-5cfa-4ac8-8946-ef9eb7dfef9a) + +Then they just have to provide the token and their email address along with their set of credentials + +![image](https://github.com/hargata/lubelog/assets/155338622/c55d7d2d-1366-4fcf-970f-513e92a93c7a) + +**Note:** The email address and token are CASE SENSITIVE and MUST be identical to the email address that the token is generated for. + +![image](https://github.com/hargata/lubelog/assets/155338622/b77d49ef-d3e3-43bf-9792-360f305ad379) + +Once the user has registered successfully, they can then log in using their credentials. + +You can also verify that in your panel the token is deleted and the user now shows up under list of users: + +![image](https://github.com/hargata/lubelog/assets/155338622/2f4a622a-cb44-4ba9-8b5d-691f677fee3d) From b453bfce5b0614080d22c2045b760771f3350483 Mon Sep 17 00:00:00 2001 From: "DESKTOP-T0O5CDB\\DESK-555BD" Date: Tue, 23 Jan 2024 17:14:53 -0700 Subject: [PATCH 11/13] removed auth html. --- docs/documentation/auth.html | 59 ------------------------ docs/documentation/index.html | 61 ------------------------- docs/documentation/locale.html | 57 ----------------------- docs/documentation/lubelogger_logo.png | Bin 8262 -> 0 bytes docs/documentation/share.html | 47 ------------------- 5 files changed, 224 deletions(-) delete mode 100644 docs/documentation/auth.html delete mode 100644 docs/documentation/index.html delete mode 100644 docs/documentation/locale.html delete mode 100644 docs/documentation/lubelogger_logo.png delete mode 100644 docs/documentation/share.html diff --git a/docs/documentation/auth.html b/docs/documentation/auth.html deleted file mode 100644 index 1925272d..00000000 --- a/docs/documentation/auth.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - LubeLogger - - - - -
-
-
-
- -
-
-
- Getting Started - Changing Locale/Culture - Setup Authentication/Multiple Users - Sharing Vehicles - CSV Import/Export - API -
-
-
- Setup Authentication and Multiple Users -
- Root User -

- Authentication is disabled by default in LubeLogger. To enable authentication, navigate to the "Settings" tab and check "Enable Authentication".
- A dialog will pop up prompting you to enter a Username and Password. These are the credentials for the "Root User", i.e.: the SuperUser.
- Once you have set up your credentials, the app will you out to a Login screen, login using the credentials you just created.
- There will now be a dropdown tab to the right of "Settings", click on it and you will see two options: "Admin Panel" and "Logout" -

- Multiple Users -

- Before you get started, it is highly recommended that you set up a SMTP server(though not required) as it will greatly automate the User's Registration Process.
- If you have an SMTP server, you can set it up in LubeLogger using the variables within .env
- To set up new users, you must first have their email address on hand as the registration process is invite-only by design.
- Navigate to the "Admin Panel" and select "Generate New Token". A dialog will prompt you to enter the email address of the user.
- If you have SMTP set up, there will be a switch right next to the button that says "Auto Notify(via Email)", this switch is only enabled with valid SMTP settings.
- Enter the user's email address, and a new token will be generated and emailed to them if SMTP is set up, otherwise you will have to send it to them manually.
- The user can then navigate to your LubeLogger instance, click the "Register" link under the "Login" button and type in their details including the token they received.
- Note: It is important that their email address matches the email address the token is issued to, otherwise they will receive an Invalid Token error.
- Once the user has registered their account, they will then be able to login and start adding their own vehicles
-

-
-
-
- - - \ No newline at end of file diff --git a/docs/documentation/index.html b/docs/documentation/index.html deleted file mode 100644 index 926cb687..00000000 --- a/docs/documentation/index.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - LubeLogger - - - - -
-
-
-
- -
-
-
- Getting Started - Changing Locale/Culture - Setup Authentication/Multiple Users - Sharing Vehicles - CSV Import/Export - API -
-
-
- Getting Started -
- Docker -

- The Docker container is the most reliable way of getting LubeLogger up and running.
- To get started, you must first have Docker Desktop installed, which can be found here.
- Once Docker is installed and Virtualization is enabled on your computer(usually at the BIOS level), navigate to LubeLogger's GitHub Repository
- The two files that you will need to download from the repository are .env and docker-compose.yml
- The .env file contains all of the environment variables LubeLogger uses such as Culture and SMTP setup.
- The docker-compose.yml file contains instructions that tells Docker how to build the container.
-
- To pull(download) the pre-built Docker image and run it, you just have run the following commands:
- - docker pull ghcr.io/hargata/lubelogger:latest
- docker-compose up -

- LubeLogger's server instance will be started on the default http://localhost:8080 and you can navigate to it to continue setting it up. -

- No Virtualization Solutions -

- Starting 1.0.2 all distribution of LubeLogger is done exclusively through Docker images.
- Pre-compiled standalone executables for Windows/Mac/Linux can be be requested, contact us for more information. -

-
-
-
- - - \ No newline at end of file diff --git a/docs/documentation/locale.html b/docs/documentation/locale.html deleted file mode 100644 index 0d978b60..00000000 --- a/docs/documentation/locale.html +++ /dev/null @@ -1,57 +0,0 @@ - - - - - LubeLogger - - - - -
-
-
-
- -
-
-
- Getting Started - Changing Locale/Culture - Setup Authentication/Multiple Users - Sharing Vehicles - CSV Import/Export - API -
-
-
- Changing Locale -
-

- The culture/locale for LubeLogger is configured in the .env file -
- You should see the following when you open up the .env file in Notepad

- - LC_ALL=en_US.UTF-8
- LANG=en_US.UTF-8 -

- All you have to do is change en_US to any culture you'd like such as de_DE
- Re-build the container and LubeLogger should start displaying currencies and date formats in your culture. -

- Important Note -

- If you have already set up LubeLogger in en_US culture and have inputted data in it before switching over a culture that uses "," for decimals
- you will most likely run into issues where existing data in the system gets returned as thousands.
- The culture should stay consistent for as long as you plan to use LubeLogger. -

-
-
-
- - - \ No newline at end of file diff --git a/docs/documentation/lubelogger_logo.png b/docs/documentation/lubelogger_logo.png deleted file mode 100644 index b3713e8067a37d3e7a04f8d777add1d4c4c27d1b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8262 zcmV-MAi3X(P)I>00001b5ch_0Itp) z=>Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>DAKOVpK~#8N?Oh3c z6h-!~o+C546B2TekN_SaUVubV!YYCnf`TaGq5`gnpr9!00pbN7tcobBhzO`CceoJ* z1SAnb5cw-0B8Lef2RX<^j=B2(zMAfFX1aQksO;)*=llIC-Bo=|cU8UjzW1uC!-5DR zh^9kQw!a(pob(;Exze4}V7ECl_i|-Fh#>y5FeuyK1rnB)w7J5a(?XWzjI>1KcS<&h zApWxWLj;Db5+7nXg9zeJiGUqc>A>$%I(BM(>IBML z_yI3anVB{>V1M0Lwb-o1A1|!KpWYc(7HX0D@e(i4^&ynT((bYP26@h;`=U+mBS8f5 z=Yy`mcnQl0N^!A~#+NE;hb}5^DjzK2anraxkXMC`v?rtvJ*DDd>|ss zz+M>@)92vARu`Zg_n>qa?fyvVElMq|7HQb!9W6fug(iqUD}(~$Ei872?0D*((`^4S z8;g!Gv2PPN_F zH$pZV`Lzcg85H?}dVJ062|osfCWt>9e8yp@qar_x61Ob<{&~vu#qRn#%HK)}R>9aZ z)^Ps=w?@7i6KRNf?UPD&>a?q#%9l`DL}@D}e(jQG<578kpqj$ou;>!RI_@U ze3Htar}QBu$6MoKpB&yd;?+=#fo<4Xcj&`)H5X-Vt>s*=Igq!eTOB6WP09MeWOf{p zx}D5dvVR!lohhjfyXjmd>j7zl`j8&EJC*EN1-*9+y>}-i>jRU+wqNR5SgK@$_zmz8 z7=VOkGi`d!T~p0QPA&Hq7H@=78bc|G(o{;tl$wJCN>5QbMG5{3e#e9TpSD`pKHc1B z`@VYC>*3w{?vE5<(gP9={0p+aNJPM~1CN!O0SP zPMZM*|D@fsE;RHEkJ2-|sbqa{*QDY>%eK}-sRf1RH$o&ZU1eF`-C$#^+lazN2aeg{ znE%H>zn?;zpXnJwGe;J&Zw}hFQ~qjxuo=+nyeEnstldBuHP(Yt4tD+sz@pjBtb{5w zLMifK=!+$6!NywnaRb~XXAe|=*|f=Y=YB=b|JAde4{^QLn$jO`UH@00ar(`fxqFJr zoExnci9LQ-)E!iW3jR+5^elAc_BtmC3#`f$ytEmRx3-L6l6qd;gDTJZU{GC z)5S7FDL(5U?bwkv!(A@fHSxXEM%qUw+l6Dzfzuq?Ut$t`CJmI1vy5l{K*$mssOE4v!3a4U)?39X#dK2qM5o+PhM4pWMPP@th?Do(6Qou3qE zynEe_TDkudC79OogZqdW)Y;q62J{V7N3}{PD1jm@BFlB0mjnRa1AayS*{iDM(XW-m z(Z7%qLf6fLEhlXS2~2+_>wz8}1AQZll&WMsAWHX+xqIF+TXx!bswqC3!5j1&IrLtW z8lz*?wXW=}R};!es=CrWQ^^}ULfvw+$&oik>d73+sUFyJT6d*;525pJBtdKg;g^|Q zPx&HAlGZv5&bLCZ%BOqy!k(S>9X+(h;ctwN$y<}-?IzO@y7ypNmM)=Z^au*+t|JB} zEjIVadqyep0S_{m*+eGGePu}^3n!P-b8a&`q){x?5n*>2=PRdrAj#4ZbB|n%?{V0& zTW2!K@FeXbNE0J5d5?>+IhM@44;pgP?x%Vk!cX*q+BQm-qai1~6IlSI-sE%L^+xq8 z%lWjw*+unc>7I|F4-e$6%w#vGt)X45f|aGG%?{fUyD8*u`n`cBljAO3fuYWehZ*?J zvMToI^wSuO)Qr*tbY3)VUZXUek}wQR{)nrr(zPT$#`qw0uu7#^1G?9A+B~v~D9r5> zN)WAkkRNCUK*#LnQ0lx|3-iW;O7_&d73eS?nh6?Xav6VCvOefMv|!i%qxRQHpx)#i z-49Q_TmI7<3#ymex2J!r7hqVlsfG={P9sMg3qG&;cIf0XbP|uy*t650Cn1?g4Wk=U zueZte^*heoJLs7*L?$@`y~o&TWo+j18Yl=T3LiMK+YEIv`E`1~c%?{)ydpfEu@$`ME!LCWYE64c4= zBfeOjUAw$rkFe`Sib!o6+Fb^LcbGz6Aq{rF`=}UBl76DcBL_WG`hijeCDWUv&p)We zN-G_p0K}QV-0gSnSq35a8bE4clB!t7xRn7c$tT@GegA99qY1iYg=)DJ?bLnRO-ivvG7f8^di9c*iSb(%7Q}T?DZ4k(C zu_}VV*Er}vw0X|q=jeb*v-`5is;Fca?w~2&BZ5!;8g-ddn%-M|z3t%)z zhRjY@L|uEkO91IkWyc3}|Bxk9;=4dtke|M|iuXs2z>pBYaeRT2F>7nBR8;0{p#7I| z%o~bj*+}X9gU4+Rm)=ugxc9|U2VL{&4@d2TC|yeXmkxcgY|u5Mi`MKrY?G5(7^6F+ zo4*~{GfXHnWPMIG*yJpOL1O0j-0Tw?~mBAi;m_2HHh$h z#n;(4;OcN;gzn4l>RD-(?6~hH>n6Pb1AY^YtB0c}xnW5Kr9-2Wpx?+3C_ral`&BL9 z`lDT{*^m-%{8-8AzK8mpwCkfN964!s%LWE2;sa_+mc36rl-4fAgxTg3v2Qnp-7lhl zc-9R&#m@|=?GPVDKApsb{&8WMgYEfIzuwfgAv*Po!z7cEkvi}LUf8_5PWTKhV~p(b zjv-624?0H5PD9;+Yr2H8#1S+!3|8W=q;}dagGp^`wM}p1OdRrmo|qJ$}XFFZc_C_v1M^zq4 z{wZg*Qse`piM6FoQlR%xpOcbj>;--YDV7=3xIUJw4J_% zcX@;t`r+}n%UQqiC63e8d_Y?RwH*rAr?n-4(G2pQu6D96_Y|xO@ zKO+*_w-#5jo5r1Dhx2Sg`tNYcF|_IGFs320*{F4e513y!G7gIVJ#b*QXy zIf+`ayPq#%o4(-OERN6XU73#k;W z!m*Q1mi0=@UqlrOVOZl16)&c06y5`VSkY-${hWz$pD0B>P&Mt4-r--99^~`!{4sBB zHBlS$3{o=6{kNzk)<(@b~%1}th{NWvvhrsZP``0IxTq7pl ze8Nc7s(kV0+68t8`#T*1?eYhrVWuTt)JkMoz;lr2&Q2g)`*88ziW=7{qfufvT^Wio z9%x7(5G}LQ?@uBscUS5y`3riDDXN@0->oRjCJB5Nvjc>nP9UrRFFNKMR+X8M_p2uV z`pd&KPBMT{F*RyEr(=xy&?pu2*71(9lC-jr$E%ul-g9wRii8}L0$Od+)Tem?xwS`bSp{Q?fo-;ePMsR*OLx;MwvmHyU5LWLa3xP!c3?HA^P9q*u}c zis;~R2OB*w92QSFUZnV$AH+l$HBm`GIlgD{%Pp@GS$6!!;XDUh_)^P!QN5xskRoF} zJ6lVr!wBh^KfFWo9*#!Tf#rPPFxBZ~f1_+7C2(R`7aJvi@Q$=9yA~CLd1Shl#UI2W zxyHTfVhes70x1G|_acXr4cY!(L)xSX=X~+;`WkEmbWBSLfM4mD zxI&eVwLy=Ll~g#{_PzD&-kZa~uZ8ovezkZKru}F@z9V~daO6SKl$e^N0fd&Yhu))& z-h0e)G4mTAZLp6|RikvZtQ4OE!E(yFw+Q)XU1qP_e+N zifHf8d*qQDj zjL5(;gVx>rSTXDVK%s|@;g3gP6kvWA{0mQ*QwKaOdpM74ZA|lT4*0lAN&@G@LM`J5 z*w02sr%xLE0XGD{7YVMoAn}_pq2ffIK{@#sBmojrhYp4-#1Y)KJLQDulxn3S&-d9h@bf1 zW`Y_H5O$W|0^-yG1%Tk=zsRzrnP&zN&BSKkwHcv3d4V6)k^7ha5vEJWmTckoSV?M`;5k&!pMkDlj~Xa(){3zqPTuz~H7f-|cuQauXPK_p$?BU|KzG0yP4tm}g`h zBg=Z4ec{F$787B}(yP#=Zh_h`et3MpM(9{}AUb9-vn5njs+9ynbx7nrmJ!)KHYs3c4VX%H{)gQ|$0 zxGP%tDX#rTZ2_$=Xp+a5&`}bNK^5wQ3tHg=6B;@Ot2}QFuPzL$pzbvA2+Xmp6m-m) zly0Vk>HC4eDG~-42^hR<4sOApulMtai!gi%&@)&m^`Z1GWpmx7V%Y5_p+*8!8o)CO z$QlW?sA}>zPERZpRVd80LUR_Aum~+$Q|Z{;iE(*!4=j)H0U9l~x9^vC{1edyoVrZ! zJ-lfnFHk`56o`)H-`Oi1bNMuYu#mNK?V6kH3Zx{)4~f$CJ)npPRBvJnrbN&7>seg{ zFsN-DZaSv@4G2_npFClGsp-LgA;`*BhK3r1$`C<|iZe2-vS%iMKOiu(3(4VYoyZjr zrlPEMIOWr|+tSuiXB9d{goT*yGN@NL27!dsMg+PaUi2=yRz~QWfRF$AfX)e{1iz?^ z5@bF*N`&s8@uL zW2;nZ{hM(e?Ad7_YEn-66grLi9UG_j9zr@6zzTzoSK zAX+GJsv`RL6EQh@Ru_uR8p4*!Ophw_{<2Mvj;RsBm+y~kuTyWBMkC2v)5qws2c=J< z&bUSr!9bGtK>C1_vol8)mcB^*?b|~Q%xIwcGf90$yi&S_&d~@BU30vw(zPtaEU|x& zkGtjCuGY@VAzjb|<38xPmXFt;aUCn5Dt52w_Xm83TS%tD_8qplCeN#2SKeR9Qg6*S zj+|PK0n|DCECra)L>plx((ho?WI6_u9~)^{rB|V96sX4)5jRnf)li$J&@rWB%x^3L z*Q;y9O>~c8{%QXD8gT2$_U!a)^xk9sXZ*c=>6qOp{Jo#a;=v#K^o96xx}Szw)YZGV zK&2<@)3MdrwJgNMRvQh5+ms?7sEX);eo;ba{&<0%E4EED63eMxH9nBfc#;ksQw8er zVX=SnuQMc4b`bX0oMsucRMV%?b{lu`u({7n5Pxt=MvmhHyAIeACeN+R=yre63$K4# z#Yd-mXM|?Z=34CgBRS>G*|@`^j^RzE^sMHT4=XTp91zkgujll6Z&Ct6>!3LM`ThSE zhMD0SWKn0gIauA^4^xB_T7ilhUT;x>6cK^^Lh;M(NbP51GmejqDT zLDuN%UkV-e3)_Z-Wn5s{Td+2DISI#YlrB~h_8}Np8o-66*O+2UMYRipf|&(ApmP!b zzuo1MI6l6WrhdDy+IvMmyQ{X5_@A@>`quAB|_9F9lM~d`8rrk0n`*zApZufyz0+g( zf;zqE7`=BwtZ}toNBZb9-VRxj5r&I+fdF65OlBD!t-^Zso>oG&FT6+QrB=4@<5nru zn8M?#^|&D;ygM)O!&l#X=onV#YTi?gDqhsqxSFy7gBFwm4yg#EWF!oE)wS|^P_8j| zM1cZe*{}w;K2fsosdrCbPTa4`K%(6;#t7aHM^l|ghW()=d?8fv&Mw0WEyoKS5SHsH ziRKDns)J=sPMw@vx(V7vSfTSb@J7?6W0(U4I`-Pbv4`lHG-CwNf~w;y>vSBIj%BnDxrZ0{0dva; zdvaH%wH8?@pl|mu_Vdz|u+D8m4&lAO`l(^iuA_zwJ!hS)H(N9%&PMms^aXsFaob)V zoS8?RT{y8SR@f)$#5ohNFGAMV+I{!FSeo8_WYN+WKB#bgzO#-U zIA-Gs`_F$+!8+VoAl?6RnM9UlE?okecZ^@G1s@!0+sb4xxM$J|mldc8w8GFI*NrKf zR8ynB+_`H93(J|E+^3NW{fHVwNQF#f%|;E3tQ$Khl7AZ49}q}Hd1#lEfF#snUD}7R zoLPxha(o|FiaeOLqKd7~;Z*A-x?V^-`~iB_drZ-+gU200I%Xnb{MNYGy39+g8td{) zp`DGIint38ylinAU5jcPv=b_!D6q~*1Re_B$_2*l7swJmn4-b9y>)ylkO;84O5{p+ zl`Mug7Eg|+YIDz|_QtX;XV}av9xQsJ33Lo@LqJgbYe52oDJ!2Al{xL_-Eq=fZx8f-?diOxC)~q3^8NgC_C}qiW>L=8XBg89N!=G z%(yo|3$Wtw)Mu$nW220i!`3X!SzV2gWa;r0i5aOat&Of6^#?j`=Ey?Kqk_pFK<|k) zAi@=lB4E1wfG0}OsP7TQ8fP~%OkWXN7;k*Cp@t2gQdV)O5Js!0Rx5XcvebXYNAOKbQtnn38*ZuH>`Xm9~86Xn*_9bzsHL~bC+#> zGkQe#jOapg7sus@Hrx^hiM%jZNMr{A(XjbjS35(`X{kb2HmOls9Zg${5B=tD)bu; z{bJ*qRs@vyrA8xR0Uw)$GSUE9b_cgM0Ras?b$$iA<7qA|po?Rak8Lz6EPxu-YZq(! zzQOL|=Atp69&Q>}tj;93hXk|^t3Z*aKi=Yo2M0vH6B%aM8Xa!jH*f8k>7@NfOc)v^ zTy|}6&JC+JPV-4m|IrqJdu`U zVk7!TB6hBMNq`<)XkJB7qckSF^unofr%#L>+8;}J6~|Ho?+Vq6T#Y2^GJJB`2{e>9 zcJ8ky%Tk2Shu?(a;OogPnYsH&`#-SvP=m|=8UW7(iqds>0efavrK8@?tvmcfhu$10 ze|Sa9vZS85^<|avZTpWl@X3Gvu-RSwQ^5C4Ddm=U^X__dGDNg;_(uUH_MDm$S{NU{ zt!H@8VSOVy-E^hZV$VrC$7C{SCR1YMe)V?#`*UQ2Jk z=G3$I#RzHcj3reFw7@d)@g!^a+(QdKufBWt!Fr)~g1-ZShc(AsFcKClc}KmIJ^cN2 z4Dg|3WL>cC0{%t(6aOwJXQ}!C?IVmSR-b1H_1n|N84c33@+v3G7+yFjuh_{go&e3E zHtGi;VlFzz{D19|O=(9?+WB;I0yG0?Cm>n{hzbR*z{wc26pj1zXy4ixn-p(a5gl$Y zdfglIkYFiAGrBX)MmGKYbW^AHX=YGN5k}U0-g!iVm_14hZ_j^utZY^jByYA zvn$nnb_=ygvsxz_FKI&xDI!c_`wrXLu>y~=0|kSE^n|3zk`E*0L{5LxffbWb6nRBX zJa=b%cG_;H6P(clI{tNIiqV;2mHpelYr7QVtTxH!E-5XIthmg{4&~YLdpL%7MYI?7 zhOIaFM^@asK4=mh1N;TXfPXoGujrqtbFrsqR?M8ayn3{9n1jy2Xf8RP{A-t!iAL$t z91-YxMBLzuT7@SIf#>GQ)am-H&JdMj(=fgh5UJ4*7e4 z5H3dXF@?UV_eNw#eI8gNTvJ5pYynmq{vi^c7te{rDTO!OU$8MCl-?vDod3}4<@f+2 zo*(nZej$OGM*<^UgX0fa+>eRbjDNdarBfKl)}yb8c%sg*#qU8W1q>AZUTBo)28@bPc*%hGne3mcyK}iP-ZQq}t76NOh3q-Ug&N_{;CI|?|?_eb~Lj2!^ zMqmJcp(!YJu0F4|8EfUkuq=7@sv3zLXzBKzVGOG$ft~vsmiKtD2;TzG2n`9si?ne& zyd)&cw${q!RW8Fn`b98u{)j`%PWqjNu~B>+$6HviOcevC|4~X9gcj$tGEUFzY#p7J zU@|ARFtD0BnSaD1x6r{rKl2Kmpii(;nCUATKTGP-$+EH2c_A0aMH^TuQ7L|X5nZ3} zpz9qf6-D?M^ceU0(?KXOfVa>fFUvBfQ8*{etT57x!g-wCKHZc$tWQM0@k62|IE|g} zErfHb`T`!1!0e?>XTwbBl-y%gbt3a9(_^)x(XjKjuNPp|Mh2+ik@9SXz+hpHqS_uFYg$Fa1K-emLz-T z^IUw6xoy=KX$>S4@_DHy&0;btPodYPWyrg;x7f#{^+>xQ$pBH_^-w5zf8j%GI`W(k?8EuJ|0l{NF2+0r6rC*BMHOA zgbXq=m>nGymLUG}(4}qw2?YM{rM&j_1PF!C#|fx>4UXYIjZv1z(;Gp+-wGm#|0e#B z&Pf81Kt2vWlr6j;{GasxCs|>c6R~dH)oeio@n?sAoUj=%XXc)=IT##!A-?^|24R7P z!6Kv}f(SwZz6b)r5Tzy$egzRk5J3bHL=ZvzFM+ZD2W@a2>P1@%KmY&$07*qoM6N<$ Eg0dmvRR910 diff --git a/docs/documentation/share.html b/docs/documentation/share.html deleted file mode 100644 index 3fa6c75e..00000000 --- a/docs/documentation/share.html +++ /dev/null @@ -1,47 +0,0 @@ - - - - - LubeLogger - - - - -
-
-
-
- -
-
-
- Getting Started - Changing Locale/Culture - Setup Authentication/Multiple Users - Sharing Vehicles - CSV Import/Export - API -
-
-
- Sharing Vehicles -
- Adding Collaborators to Vehicles -

- By default, users are not able to see other user's vehicles. To share a vehicle with another user, simply click into the vehicle.
- Make sure that you are on the "Dash" or "Dashboard" tab, and look to the bottom left where there is a little panel called "Collaborators".
- To add a collaborator, simply click the "Add" button on the right and type in the username of the user you wish to share this vehicle with.
- If the username is valid the user will be added as a collaborator and they can now view and edit the vehicle.
-

-
-
-
- - - \ No newline at end of file From 0d1c7234e83de951bba443e7cbb25af592274c3c Mon Sep 17 00:00:00 2001 From: Hargata Softworks <155338622+hargata@users.noreply.github.com> Date: Tue, 23 Jan 2024 17:22:07 -0700 Subject: [PATCH 12/13] Create Collaboration.md --- docs/documentation/Collaboration.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 docs/documentation/Collaboration.md diff --git a/docs/documentation/Collaboration.md b/docs/documentation/Collaboration.md new file mode 100644 index 00000000..9f919045 --- /dev/null +++ b/docs/documentation/Collaboration.md @@ -0,0 +1,21 @@ +# Sharing your Vehicles and Collaborating with Other Users + +LubeLogger allows you to collaborate on vehicles so that more than one user can add or edit records on a vehicle. + +To share a vehicle, simply navigate into the Vehicle's Dashboard, and look to the bottom left + +![image](https://github.com/hargata/lubelog/assets/155338622/76eda35f-5547-47d9-91cb-3fbf30d2a3d9) + +Click on the little blue button with a User Add icon and you will be prompted to enter the user's username + +![image](https://github.com/hargata/lubelog/assets/155338622/6bbcc309-a790-48e0-91fa-24c57df20531) + +**Note:** The username is case sensitive and the user must exist in the system. + +Once you have added the user, their username will then show up in the list of Collaborators + +![image](https://github.com/hargata/lubelog/assets/155338622/edac8c3b-eb3e-411d-ab45-e54cb66206f3) + +Now the user can view and edit the vehicle as well: + +![image](https://github.com/hargata/lubelog/assets/155338622/85b0aacf-ae5c-4361-8d1c-32f9ec637a5b) From 8c6dd5e343d354df369a9388305c6e4a07f914aa Mon Sep 17 00:00:00 2001 From: "DESKTOP-T0O5CDB\\DESK-555BD" Date: Thu, 25 Jan 2024 17:52:13 -0700 Subject: [PATCH 13/13] Updated website --- README.md | 11 +++++++++-- docs/index.html | 24 +++++++++++++++++++++++- 2 files changed, 32 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 066727a8..8a303b41 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A self-hosted, open-source vehicle service records and maintainence tracker. +Visit our website: https://lubelogger.com + Support this project on Patreon: https://patreon.com/LubeLogger ## Why @@ -10,6 +12,11 @@ Because nobody should have to deal with a homemade spreadsheet or a shoebox full ## Screenshots Screenshots +## Demo +Try it out before you download it! The live demo resets every 20 minutes. + +[Live Demo](https://demo.lubelogger.com) Login using username "test" and password "1234" + ## Dependencies - Bootstrap - LiteDB @@ -22,7 +29,7 @@ Because nobody should have to deal with a homemade spreadsheet or a shoebox full 1. Install Docker 2. Run `docker pull ghcr.io/hargata/lubelogger:latest` 3. CHECK culture in .env file, default is en_US, this will change the currency and date formats. You can also setup SMTP Config here. -4. If not using traefik, use docker-compose-notraefik.yml +4. If using traefik, use docker-compose.traefik.yml 5. Run `docker-compose up` ## Docker Setup (Manual Build) @@ -31,7 +38,7 @@ Because nobody should have to deal with a homemade spreadsheet or a shoebox full 3. CHECK culture in .env file, default is en_US, also setup SMTP for user management if you want that. 4. Run `docker build -t lubelogger -f Dockerfile .` 5. CHECK docker-compose.yml and make sure the mounting directories look correct. -6. If not using traefik, use docker-compose-notraefik.yml +6. If using traefik, use docker-compose.traefik.yml 7. Run `docker-compose up` ## Additional Docker Instructions diff --git a/docs/index.html b/docs/index.html index 628a2169..676183b1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -126,6 +126,21 @@
Features
+
+
+
Try It Out
+
+
+
+

+ Live demo available here +

+
+
+

Login to the demo using the username "test" and password "1234". The demo site resets every 20 minutes. +

+
+
Where to Download
@@ -170,7 +185,14 @@
Where to Download
-

LubeLogger is proudly developed in Price Utah by Hargata Softworks +

About
+
+
+

LubeLogger is proudly developed in Price Utah by Hargata Softworks. +

+
+
+

Support us on Patreon