From ada534f8d08fba47f1b706dd4d7082232df6f2ab Mon Sep 17 00:00:00 2001 From: DrMxrcy <58747968+DrMxrcy@users.noreply.github.com> Date: Mon, 8 May 2023 14:38:43 -0400 Subject: [PATCH] Add Plausible (#475) * Add Plausible Analytics * Update config.json * Update docker-compose.yml * Update docker-compose.yml * Update docker-compose.yml * Update docker-compose.yml * Update Secret Key * Remove User Registration, Done Via UI * Update docker-compose.yml * Update docker-compose.yml * Update config.json --- README.md | 1 + apps/plausible/config.json | 37 ++++++++++++ .../data/clickhouse/clickhouse-config.xml | 16 +++++ .../clickhouse/clickhouse-user-config.xml | 8 +++ apps/plausible/docker-compose.yml | 56 ++++++++++++++++++ apps/plausible/metadata/description.md | 25 ++++++++ apps/plausible/metadata/logo.jpg | Bin 0 -> 6502 bytes 7 files changed, 143 insertions(+) create mode 100644 apps/plausible/config.json create mode 100644 apps/plausible/data/clickhouse/clickhouse-config.xml create mode 100644 apps/plausible/data/clickhouse/clickhouse-user-config.xml create mode 100644 apps/plausible/docker-compose.yml create mode 100644 apps/plausible/metadata/description.md create mode 100644 apps/plausible/metadata/logo.jpg diff --git a/README.md b/README.md index 67db7581..9d6b87c6 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,7 @@ This is the official repository for the Tipi App Store. It contains all the apps - [Peppermint](https://github.com/Peppermint-Lab/peppermint) - An open source ticket management & help desk solution. - [Photoprism](https://github.com/photoprism/photoprism) - AI-Powered Photos App for the Decentralized Web. We are on a mission to protect your freedom and privacy. - [Pihole](https://github.com/pi-hole/pi-hole) - A black hole for Internet advertisements +- [Plausible](https://github.com/plausible/analytics) - Simple, open-source, lightweight (< 1 KB) and privacy-friendly web analytics alternative to Google Analytics. - [Plex](https://github.com/plexinc/pms-docker) - Stream Movies & TV Shows - [PodFetch](https://github.com/SamTV12345/PodFetch) - A sleek and efficient podcast downloader. - [Portainer](https://github.com/portainer/portainer) - Making Docker and Kubernetes management easy. diff --git a/apps/plausible/config.json b/apps/plausible/config.json new file mode 100644 index 00000000..afbc7968 --- /dev/null +++ b/apps/plausible/config.json @@ -0,0 +1,37 @@ +{ + "$schema": "../schema.json", + "name": "Plausible", + "port": 8190, + "available": true, + "exposable": true, + "id": "plausible", + "tipi_version": 1, + "version": "v1.5.1", + "categories": ["utilities"], + "description": "Simple, open-source, lightweight (< 1 KB) and privacy-friendly web analytics alternative to Google Analytics.", + "short_desc": "Simple, open-source, lightweight (< 1 KB) and privacy-friendly web analytics alternative to Google Analytics.", + "author": "Plausible", + "source": "https://github.com/plausible/analytics", + "form_fields": [ + { + "type": "random", + "label": "Plausible Secret Key", + "min": 64, + "env_variable": "PLAUSIBLE_SECRET_KEY_BASE" + }, + { + "type": "random", + "label": "Plausible DB Key", + "min": 32, + "env_variable": "PLAUSIBLE_DB_PASSWORD" + }, + { + "type": "boolean", + "label": "Disable User Registration", + "hint": "Check to enable Registration", + "default": "true", + "required": true, + "env_variable": "PLAUSIBLE_DISABLE_REGISTRATION" + } + ] +} diff --git a/apps/plausible/data/clickhouse/clickhouse-config.xml b/apps/plausible/data/clickhouse/clickhouse-config.xml new file mode 100644 index 00000000..dc1e36b7 --- /dev/null +++ b/apps/plausible/data/clickhouse/clickhouse-config.xml @@ -0,0 +1,16 @@ + + + warning + true + + + + + + + + + + + + \ No newline at end of file diff --git a/apps/plausible/data/clickhouse/clickhouse-user-config.xml b/apps/plausible/data/clickhouse/clickhouse-user-config.xml new file mode 100644 index 00000000..ae6a6b94 --- /dev/null +++ b/apps/plausible/data/clickhouse/clickhouse-user-config.xml @@ -0,0 +1,8 @@ + + + + 0 + 0 + + + \ No newline at end of file diff --git a/apps/plausible/docker-compose.yml b/apps/plausible/docker-compose.yml new file mode 100644 index 00000000..b566b5ba --- /dev/null +++ b/apps/plausible/docker-compose.yml @@ -0,0 +1,56 @@ +version: "3.7" +services: + plausible-db: + # supported versions are 12, 13, and 14 + image: postgres:14-alpine + container_name: plausible-db + restart: always + networks: + - tipi_main_network + volumes: + - ${APP_DATA_DIR}/data/database/:/var/lib/postgresql/data + environment: + - POSTGRES_PASSWORD=${PLAUSIBLE_DB_PASSWORD} + - POSTGRES_USER=tipi + - POSTGRES_DB=plausible-db + + plausible-events-db: + container_name: plausible-events-db + image: clickhouse/clickhouse-server:22.6-alpine + restart: always + networks: + - tipi_main_network + volumes: + - ${APP_DATA_DIR}/data/plausible-event-data:/var/lib/clickhouse + - ${APP_DATA_DIR}/data/clickhouse/clickhouse-config.xml:/etc/clickhouse-server/config.d/logging.xml:ro + - ${APP_DATA_DIR}/data/clickhouse/clickhouse-user-config.xml:/etc/clickhouse-server/users.d/logging.xml:ro + ulimits: + nofile: + soft: 262144 + hard: 262144 + + plausible: + container_name: plausible + image: plausible/analytics:v1.5.1 + restart: always + command: sh -c "sleep 10 && /entrypoint.sh db createdb && /entrypoint.sh db migrate && /entrypoint.sh db init-admin && /entrypoint.sh run" + depends_on: + - plausible-db + - plausible-events-db + ports: + - ${APP_PORT}:8000 + environment: + - BASE_URL=${APP_PROTOCOL:-http}://${APP_DOMAIN} + - SECRET_KEY_BASE=${PLAUSIBLE_SECRET_KEY_BASE} + - DATABASE_URL=postgres://tipi:${PLAUSIBLE_DB_PASSWORD}@plausible-db:5432/plausible-db + - CLICKHOUSE_DATABASE_URL=http://plausible-events-db:8123/plausible_events_db + - DISABLE_REGISTRATION=${PLAUSIBLE_DISABLE_REGISTRATION} + networks: + - tipi_main_network + labels: + traefik.enable: ${APP_EXPOSED} + traefik.http.routers.plausible.rule: Host(`${APP_DOMAIN}`) + traefik.http.routers.plausible.entrypoints: websecure + traefik.http.routers.plausible.service: plausible + traefik.http.routers.plausible.tls.certresolver: myresolver + traefik.http.services.plausible.loadbalancer.server.port: 8000 diff --git a/apps/plausible/metadata/description.md b/apps/plausible/metadata/description.md new file mode 100644 index 00000000..3e243be7 --- /dev/null +++ b/apps/plausible/metadata/description.md @@ -0,0 +1,25 @@ +[![Plausible Analytics](https://raw.githubusercontent.com/plausible/docs/master/static/img/plausible-analytics-icon-top.png)](https://plausible.io/) + +[Simple Metrics](https://plausible.io/simple-web-analytics) | [Lightweight Script](https://plausible.io/lightweight-web-analytics) | [Privacy Focused](https://plausible.io/privacy-focused-web-analytics) | [Open Source](https://plausible.io/open-source-website-analytics) | [Docs](https://plausible.io/docs) | [Contributing](https://github.com/plausible/analytics/blob/master/CONTRIBUTING.md) + + +[Plausible Analytics](https://plausible.io/) is a simple, lightweight (< 1 KB), open source and privacy-friendly alternative to Google Analytics. It doesn’t use cookies and is fully compliant with GDPR, CCPA and PECR. You can self-host or have us run Plausible for you in the cloud. Here's [the live demo of our own website stats](https://plausible.io/plausible.io). Made and hosted in the EU 🇪🇺 + +We are dedicated to making web analytics more privacy-friendly. Our mission is to reduce corporate surveillance by providing an alternative web analytics tool which doesn’t come from the AdTech world. We are completely independent and solely funded by our subscribers. + +[![Plausible Analytics](https://camo.githubusercontent.com/74a68bf1e55052517b1eab2e7ec8fb12a2f065e5cd6f12dd2a5002f6dcdc0d82/68747470733a2f2f706c61757369626c652e696f2f646f63732f696d672f706c61757369626c652d616e616c79746963732e706e67)](https://camo.githubusercontent.com/74a68bf1e55052517b1eab2e7ec8fb12a2f065e5cd6f12dd2a5002f6dcdc0d82/68747470733a2f2f706c61757369626c652e696f2f646f63732f696d672f706c61757369626c652d616e616c79746963732e706e67) + +## Why Plausible? + +Here's what makes Plausible a great Google Analytics alternative and why we're trusted by thousands of paying subscribers to deliver their website and business insights: + +- **Clutter Free**: Plausible Analytics provides [simple web analytics](https://plausible.io/simple-web-analytics) and it cuts through the noise. No layers of menus, no need for custom reports. Get all the important insights on one single page. No training necessary. +- **GDPR/CCPA/PECR compliant**: Measure traffic, not individuals. No personal data or IP addresses are ever stored in our database. We don't use cookies or any other persistent identifiers. [Read more about our data policy](https://plausible.io/data-policy) +- **Lightweight**: Plausible Analytics works by loading a script on your website, like Google Analytics. Our script is [45x smaller](https://plausible.io/lightweight-web-analytics), making your website quicker to load. +- **Email or Slack reports**: Keep an eye on your traffic with weekly and/or monthly email or Slack reports. You can also get traffic spike notifications. +- **Open website stats**: You have the option to be transparent and open your web analytics to everyone. Your website stats are private by default but you can choose to make them public so anyone with your custom link can view them. +- **Define key goals and track conversions**: Set custom events or page URLs as your goals and see how they convert over time to understand and identify the trends that matter. Includes easy ways to track outbound link clicks and 404 error pages. +- **Search keywords**: Integrate your dashboard with Google Search Console to get the most accurate reporting on your search keywords. +- **SPA support**: Plausible is built with modern web frameworks in mind and it works automatically with any pushState based router on the frontend. We also support frameworks that use the URL hash for routing. See [our documentation](https://plausible.io/docs/hash-based-routing). + +Interested to learn more? [Read more on our website](https://plausible.io), learn more about the team and the goals of the project on [our about page](https://plausible.io/about) or explore [the documentation](https://plausible.io/docs). \ No newline at end of file diff --git a/apps/plausible/metadata/logo.jpg b/apps/plausible/metadata/logo.jpg new file mode 100644 index 0000000000000000000000000000000000000000..27bf655b92736e26ef1841742a1ea7061b0c21f8 GIT binary patch literal 6502 zcmb_gcT^P5lb>bDaaV#Muq4SjBcLo%a!wKj6a~pFIS5EbKyuD385D_15S0u{j*F6m zAgl-og2)Z}{oVcUy}N(zUCqAfu1{5WPt|nQZ1u(L#S#EhS5Z>|AP@k6fERG_8(>m& zb$0W(@9BB}9NB|NcDbXd7Qj(IBf`C$fXP#x8DT-w>m!@fgAu$@rnlTi{7LmAScVo*ag1LsWT;z zfef0x0Gj}-A@C0Lx^<+6fa3&~jtW6mT#%P23mix`c9R)op;?WE>W%_vU;d8^p!hC`Nkt8X8HgHezBdbJAvUxN_O?FkMS}QpqAWXinkkmkg%u7X z%J_8Za5)1x;{lFZ>fHYH7v<|PwHr(mJRu;u;>tiAn`uEU42Ojf9a)zkK}@ReEpC}X z_`7Z;B^C%b#`4l==rgZqb$e4MaK|Vy6QPdvLO^gmPXu@PBRvHi7LB}ujZe7L%NF~= zrKayri&9d65&18U&Ub;Rr_Ym_?$XNGZY5S0fU{Pb;ZigAh1q*54g;wgO$As8qWqA4 z2SkC*ryNYi<2;%x`+Bf&7)OBTA1B{9Akm5Y=3$uCYrDb%3z254?gDkm@FH6tS^0_B zn|{5g#0n#OKX;70gejt$>_5Kwu9lVSEet1QcBy-N3c>*X)Ax7k?MG6+9dfvz%qlQP zjZFm6>0U}6{^F0LahmNt8NObBvc?K^IFf6;#G%SIyQU5HAL3}=$i;LA!lFemK7mfK zOA#4Sbc_8|js)Lq{R3y~1Jl<2Q#tqDx{ym5!vzpkJXLM%WCkv0eZDueb;NsyE5dO&rIG1j% z_&4c)b+s|>sl5~1%%Imt9P&xYMb!a-QRhB0TOw#H*#+PaNLir(9Bla-Kyu420f3h8 zA|V6&OTbMER0t%X4+;3^8x~)Eu5M6}bg%_b7!8o-bqwxgDJK>b0u=f~Neu&augeUV zeD4AjnzM!ySNDv>;X{6=0EPS~EtUJ*J6V~D0vkxc8#A0$nc`hlrX`uu1(5d%dU@OL z4sMjL`dPID(7OHsj8%43ontP=jp-0TdLgdG^W}EcgR9x={2>5i#951gw}ON?dj9IVEaE1=+JARFQNY} z!2%E*Ts$cLA9q6kcXuW-5i1`CgaE+ElYT_oAs85Z0NEK5AZ;Ioj86g(2FDN*Z$1FZ zBn!~{gaGTC0Im-baIYYKN01ks38tb@Yr<%fAR&PKCbOR&3{jv2X1%p1AL|J@AKV29 zMBg!&DlvPDhX9+KH441Ai1R{#lzIdf9ZvHVj6+*=AS(x)Lc6>IfKsz|qEZE`?}Y%g zkEml0N&LZ(!?Ue-$pqUx(`Za7=#Am%#GoZG0SYvfTY%3@yNh)L{zn2`q5%USP|znt zB!q;x1eaQuTMWR1;}gKHFtZ5D>)M1;Qn9iNArKAMfEgnBKo$T#be6P zQeTRSE7^r5zy0SE1(5?T0PdbzvM_WlH#9XRHme#nOd4a-8of=9_qauDZ$iw#qNR~{ zPonAZ_k^iNv>{aBW6gffe~;~Xtk zKE-_b>vs*wskuc~li#mR$lQDS(}kndu2srSX1yqVvd?-e}XTt}j?l%IfD4N+o7;PAonEWY^nig`hIdcm6F zr`wZtvGdwvcufMcPKi)qB>FgIEA*7@q*7f!)ewE9*h6jg`p*jX>o8U3HMqINyj-vk zJ>Jj#MOvbGmf(~Vs>cDv5=nJ>Wy|y^yeFt<34&)_a+>4QEygVjdivAqso(^+T++CC z)RR?pZ{T`_@!FehSr^BNe^{jJyB$*UB?tVJ_@X4r-t2Wy;uIfNxol0!Pte%grMp zVm`7;@@%}Y$5V*8qKJ0QJU7-P?<>|wP;=32Z>Xp94w)Lm!1>e$-)Vxb8b~u*D;r_e<6FmU#ZHEe?$f0@}|g86#fJ6Tm7( z7}8jN3UXEUSs27}rlv7W2Yz2F&UCF|;ARU<*=Aldj_54c`=Y@=%PSzm$nEnpn$`rl zo3LTy5V_1^YB5J7|MryVTfBWk*GR54V$Uu1#)2;OcT~sKuQNIHv8&N1L2p{I$lYc? z|0AcC2%OCQxG1cY@12_Izb{pt&5k2*4QFvwB-;NXpJLCo`lywmVNt-xQ{xv_om zgR?geZgds+&#O{*xn6Z>e${rUTWu+R!skyh8&ivkDl}b;FrrlK2q}Gzf+;>S1$AO zry51{*V>6;sgA~#N$~n;sI3EKkTvFIpqD0Td1T z^w>qk_HGW$kNO;+t&DX;-Oc5u>q4i$`t)r4o{=uF;tC@|Xzvb=yx3cfNWhn(tuY?t zQ+ZqL%-5PL$IfBUIpf=h+)m0<^gT|S+7R^r=n3tzj?7==^jd$^;z{57smHE=%UQNV ztBPNuFwD&St!vWoxYU$Zb7YR9Rw+B7sycE5TIeP8v9RrIa7R}jn;A4mH1u@;%wS|~ zFF&p&G=9NYHvO$wQG|0w<$6<;eQ=e8U$zeS?oGT(71v`|KTB>PELnsCUfm7Fu^lDY zPFrR^Vq*6^v}}qWc3FM$#~}-2^Y+>`Z{9Za5%@Mm$adZn%NM^EN-W+?WeTS!w3ShF zZcMmWYFF4qyT3d0*+f~~x0z#^T9tOM;#sF`_6YsCS{E2l5Krk0;1R3JFiRDYQMk2Gc&xO_ps&qQ?m7S7-0G%2KoS zJqX1g*Jln|^hXa}Uw2?qx&T~R+zx}ctF#a~d)T63A!kG7eVZyLTQ z?Y&>IkI`_JcoxpW2H|E1L9rkDZfs&ninDdm#AXVixcA^;WLAf#S-fdPH(b-S5)99z zJb%*fg2r`SZll^9r(!F#drrp}65G*aVtwBXwhI3gJyw+`beV2*ike~};Ve)hRYsCP zo%lVu5lgr_Rh3v(o5PPaY(Y%8%%H(=l~;!89p^PFK7``ig8oHU0_p^OUg|3hmE-hr zWD)IWQH0KoXY5r zDkGjWb+mq!6YYdvd(aCVktnXp=^Mf^=5$`2&*!P+>2U9kE);B?`3Scq5US}Bsb0@V z@~Szd=x-Z|vubcG0!tYMv}RG?I2!ZACgyKG%R%YBx^6R|y{uh*MjqYC+dIRwSr>!8 z1}>wLp|?IDg*(FLH#Nn-s#s1TrKqzp6` zI2QD^q}Gq;8WSr4&8jr4GA5U&E=D18-ppR*IB;}cZ#{i?H8~=@yjEPsMp|2*Cq}@@ zZkvQeXNBkXz!4pXK*_B>TJ*1ixuTxXgc(BgQs z6-P|*!)(1`2bDCHG_zaq(6U`Vcm$2Y)UI{Jc*g2#PC>gsgVLB0rP6pjrMg&&(o{Ba zozJ5{D$-+)JO`Vn0Og{YDZId}R3Y$J3Ra}8Vp=+G{G2|G ztri1qF>-LGcAs=%U&rYN0y$HqrY2*X%wGbbJQj}|}Y{^J1S zv-|J1PZC|DSBKOSXj~Dk^u(-mJGl7$OM?huIK=jFJu*p`?5DM2f-0n+52{;5F3)`MFZIg zk-^|1gyxuAy5147mB!2Y?2^YReWylJj6pX?#6L=IeBcTjR}95jfJi4cqmtH!{ScE7J4MOm|#l zv(Xg!X60n?r?pr)rqn~@`!@qr!ZdZT*Hl(Rx>(*9%id$(TwO&mY;y8sn`0Y^qHJ7N z6-MW!b)}R>v?DrazpQ6y&^mQQmQ={jyf8c>$Uf^V2fLr9Eaf*k_o}uN#f0YbSvnna zDDElUGRS&=cd0s)y`(DoD@q4p=Zk=H#O8$zdZt|vB+%T^;h51+NH z^`4>%rJD%eYdB z`u>of_H)HTk#t2n1dp^XW`;?(IO}EHlk)W+VV9=c-%0c4)Qal07CpxfzHO}0pseUd zk8n2-EZ?1#l)|r)Bh=E;WG{sodU4vlbBgzVS63H$CryRzwmMO^x8%!Xo|e=-=9iH& z!N(WClKuxitcd3E%}obRRJdcww{RQ?F3gBF&77wkB~C&1(MhmKlA$}Be`K+vh{10FoI-h<8V-9Gz{@C>HuzZ=wS!F6>LcRTF|_ zrjayde`cWKGELvsgjpb)>{)UxehC5UHPsqxgt}ctqfWxrt|z-_9|M0y?vEgz3)cv) zRM(d^O7kfCI0-Jvq~vb4zUt0kEX6+UE4=4)H*_sB^sPqXunS8>?XI-pk(W5ff%>Mm z+iwXl+WFy^$JY3`czFLhmV$sh92dqSjC8-kETTurDkQH!rElYw6#Dm6BO0`7kT2((YN5$5+$SsvcUQ zVFe*CV>(8%+N~m)(;qi7+e=zU=gngse%b8IZRk%%&HhA*3i~V^q(em!tjCG)fWFwg z)gJBrm2%&GeT0n^DXzxb(H}NN!OaT?q6QHBZBMQPffam3dC}Tq*$-Kp=y8)+r}|Hk zkq-}=H?taEXN+@Gz3$F6XzfTfQ4}(4{?#W_8N`~TT57ufO?~A?voy`N^KyDrYL8&4 zJ~vgIYyoxG$x}^I{D{{H-;9f&$>T?*XMloO1&s%Ht5^-usi7({4U$6mglzdqsu|p6 z*SKQz({&3+7Pc^=9lfN~yST`~ZHt$Ar-t2aobB&_6B-e7;o&DW$SmCbocydftc2^- z&)O+S_IWdI<)dUW8GGCI&w?|2OH-4F6_q%>cro`Mj#}Lu literal 0 HcmV?d00001