From 1c6cab8fd276dbe15e40dd3d16fb0e2371d97e1b Mon Sep 17 00:00:00 2001 From: orhtej2 <2871798+orhtej2@users.noreply.github.com> Date: Thu, 21 Sep 2023 00:14:08 +0200 Subject: [PATCH] Added docs for umami --- images/umami-logo.png | Bin 0 -> 3501 bytes .../10.docs/umami/app_umami.md | 53 ++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 images/umami-logo.png create mode 100644 pages/04.applications/10.docs/umami/app_umami.md diff --git a/images/umami-logo.png b/images/umami-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..14c12ed9554fb53bb6d84db03d2bebf33b9e2dc3 GIT binary patch literal 3501 zcmb7`X*3iL7slzxS8j zfBF6U_s-7F_VzZJOy1hs`t|D+3&%{#;vITU}jUSy@?LUS3*S zT3lTG@#DwB!ov6O-@kqPHa|ZCc;rY0vRCnhGw$H(z_{Mgvo z=;-Lk$jI4vGLuzcMS~o` zO-)U8bu|`?t*WZ3tgNi4s34E-ET|{rYubVPQc*L4JOIUS3{q zZf;IaPIh+ot5>hGva&KWGhe=Z`QpWk=g*&KWMrhLr(-afw6wI8l$7M;WHcI`l$4a1 zn3#}|5FZ~O7Z(>B8;e4rVq#*VqobcadlnTH6&V>B5fSn9>C^D=@F!26goTBLhK7cO zggk!yI5;>sC@3f}Ffbq>;L)Q;{{H@cetr)hKJ@kV_3`oX_V)Jj@}+goU@(}Km6e5s1q1>yF);ywz)P1d0RR9-Mn(n( z26}pWIyyR9T3Q+!8ft3lzfngGANNvG0h0`1+E!uITOW_3tfmAR7DFFAH_nPS;C%kf zg#!$eU5rOtHTadwUTu}JDT0bLUlk!Q`@!iC#S9y!nXTSJ!JGlq=H_@RHjqBx671cu z#8VlC>KNdkHXRG7PZ_I8TQ>f~(S*D3m_k46AL_Z5= zl=b-#7y1=p*UMdI(|vpEU9>^s*|^WQ38Sc`3+uLjrpqG1CnY4}E0q9YtIhy~aAIcw z!J|?6k><;8^=8RFp*6%|+j69(rZJhSfq$d-2lDPMg^`3;Yg)fHk2coOwOVJC<#ef7 z+vRvA7Kc=5hm7!Y)UKb5t*`aw%tnDoq-9uCrfZGmP88akZOKX;z(zb;ao%Z{FVy_dkX>}f%K$xG z+pez3R4cm>dGA`Dr4zGORY8||LryKn-t_>mJFerAM&7(SgQ#)K{;}qp;YsngZBm4x($!K!<5GPMC_6~vQNUN6?nqW7+FRNCK110@EEk}H20mUgi zmcE;njk{v11oqFh?v^7bPXGn^Ef&7sOKf~Q+HWR|mCLi%#N7img9$KiLv6Zq)zv|u za&Z?i=B@#^jB>+yzVeRA^apvuWJ`iLY}sE%`C7d#!#|v)TQ5u^axi0wovUw?I&Q)i z>qAxqmCf^E`mjP{yphQOYMXuCcEV^lSzLfzS7|%ke~C_HFGVq2tLYPh-4beu0s zC$`e3wC^1T5Z(C<4X+h^8U3s;jq=j5Nu?*O(ywF&eeMM?#(mZa-)iNJC%rFpbUH{A z)5;iOB3j=D>m^?#IFcxE@EgC^Vuy^BNPchqf7CAvG(E_Ol?c8Ro>*)xhv?z!d>|9gMWy znBm;oJ|X0?@t%mr!b8U4%MZrgBIzFRy+zfH-ySo?uLqZppv+y9iPxaOvwRDqnL~qY zcbx8w&+OP;3TnTVhr!Fq&=xL?#ICRgTOY)!Rp8wWIm01vOjIu~Jy&o<2CK>1du`jZ z28Dk2_Q{+vn{HscV~pr?kKkdnu0z8-aqbD-SB1j5RE^?>n0jI^i}>Z~aV0gH0)&>W zHJkCHD+rIcG5h7~?c```MVkpF=G>0#x?LKgf2(Wht{C#_A%DAH?D;}5DFEqz3qcw$ z>L{^SrZn;3UR`h?x)aEsCX{3t&P>WlUPM27{&LDkD#0N_l_GWLK@fr1dn4PK0U=)8 zazbop*HcZaJ07#AFeq0KB(N>l5UMJu)cJL0?(@1r5i3QFv%v){y8HSKcuzK>jN=!* zD{2Zb-)sD8-;3*`gEeT}Qi@4Hq7M*p=91C_R1W8Ze9r14RD!tcDiG2Y5A?W`O8x3Fj?W8-6y967C>KO%ZwUGqse7y4e%k`-z%vp3bh@7 z3iI*hV|m@5?3I!EaH(Dtt;|OqHC$xv7~P#U0p(w;SHhuVx($&$M>Vk_(f>n`?#$7j zL(371^?`o{CG)S*0>^Y({`V_6E4mxWcVvXWx??N2MH6K`0hK=T;jgt|iF#OJJ>BC( zLT1V@)pOwnEsjVU_8zxSl@e@n=%Y0BYQ8Z>nUq^g^frA9>iL$M`TYT0<$Pk z&l}i;V9UpC^93@2%kuaF#o5Zpk3mht26Wz{x?3)EKD@oMQ>-5cX9vIz5bY0S=fqT< zv36fiWM&h5vCsqgJ!w&J{zE!+J9ZJytx!frv6zPP8ge0uQ3Ticanx9E4vQ{werZhC z_mVC#lDKS~P~6xAXit=LC4OU$04;n;KQ0GDoF|0{aq=b~a4n*^Tn$9K&OpSjU_jAuzOl(2 z2*iH~KQ;}5_mjcE-j$7-6XRnkeZ?K)1Risou}4y{4+c`Q>PS|+l@FUth`Mj zxEVJ&<|e62w5KjIskrv*DGJT;43sA#px^rFPgqsjih(c$USZ0%SKx^eXR5_heq)Qb zR(O%em|j`>Au@^f#&;oF!Oac1yj5tT>Qo@S`IEw8A#ERUG~OUKYFev3d*3n z7O{9YsL2fG@@6%UdD4D3LSgPJ#M}48ikFU_9T@}Y)-ApCorVpX*HH(eTV}L)t$LH`DtW*Ud(;h30p2?wQ&q69#WC^ zF7k^M)xnaU9)NP^0_1w2>VC(`AY~`A;(2nnz`^P$xanOD$ zRnnc$&ZyqPdh7k1>Q*KGW};?yVWdTq8CQ=4>b4c{#!FUG+}6Z zwq3xuw0XlNz_7u(YEDId6ovemF0($htA!mNO&f?tn*T!#a%jB>`Pxy((^m)!M_dca z?2X8>SM+cOx%#^o1`h9IplvONKe{~iCHlIgRktXWnhPH_s_cJLXiLooVhH~9sDw0# z#(71DP@&pM6MetY!tu=B#CCzA*Vik(3H!tG|5wNRZ*z~%1-+ngo}5Qw3iNL`r80n< K!s>LKWBvo&K&cM^ literal 0 HcmV?d00001 diff --git a/pages/04.applications/10.docs/umami/app_umami.md b/pages/04.applications/10.docs/umami/app_umami.md new file mode 100644 index 00000000..6aca21da --- /dev/null +++ b/pages/04.applications/10.docs/umami/app_umami.md @@ -0,0 +1,53 @@ +--- +title: umami +template: docs +taxonomy: + category: docs, apps +routes: + default: '/app_umami' +--- + +![umami's logo](image://umami-logo.png?resize=100) + + +[![Install umami with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=umami) +[![Integration level](https://dash.yunohost.org/integration/umami.svg)](https://dash.yunohost.org/appci/app/umami) + +**Umami** is a simple, fast, privacy-focused alternative to Google Analytics. + +## Getting Started +- Install `umami` on dedicated domain (does not support subpaths!) +- After installation the default user is `admin` with password `umami`. Change these as soon as possible! + +## Upgrade +To upgrade the app once a new `umami` version is available, simply run in a local shell via ssh or otherwise: +`sudo yunohost app upgrade umami -u https://github.com/YunoHost-Apps/umami_ynh` + +### Migrating from 1.x to 2.x +Upgrading from 1.x series to 2.x is a multi-step process that cannot be automated. It involves: +- Upgrade to 1.40 - the latest version in 1.x series. Intermediate steps may include upgrade to 1.33 (first version to use `prisma` for schema versioning) and 1.33.1 (which introduces breaking `prisma` change). +- Running dedicated script for v1 DB to v2 DB migration +- Upgrading to latest and greatest in 2.x series. + +The script to perform this step is as following (assuming this is the first instance, named `umami`. If it's the second instance use `umami__2` etc.): + + +``` +# Install latest 1.x version from dedicated branch +$ sudo yunohost app upgrade umami -u https://github.com/orhtej2/umami_ynh/tree/v1.40-enh + +# Run migrations +$ cd /var/www/umami +$ yarn add @umami/migrate-v1-v2 +$ npx @umami/migrate-v1-v2 + +# Update to latest version +$ sudo yunohost app upgrade umami -u https://github.com/YunoHost-Apps/umami_ynh +``` + +## Useful links + +* Upstream app code repository: [https://github.com/umami-software/umami](https://github.com/umami-software/umami) +* Docs: [https://umami.is/docs/](https://umami.is/docs/) +* Application software repository: [https://github.com/YunoHost-Apps/umami_ynh](https://github.com/YunoHost-Apps/umami_ynh) +* Report a bug: [https://github.com/YunoHost-Apps/umami_ynh/issues](https://github.com/YunoHost-Apps/umami_ynh/issues)