2021-07-10 18:27:01 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2020-06-19 22:18:51 +02:00
# Matomo for YunoHost
2018-10-30 10:25:13 +01:00
2023-01-27 12:17:51 +01:00
[![Integration level ](https://dash.yunohost.org/integration/matomo.svg )](https://dash.yunohost.org/appci/app/matomo) ![Working status ](https://ci-apps.yunohost.org/ci/badges/matomo.status.svg ) ![Maintenance status ](https://ci-apps.yunohost.org/ci/badges/matomo.maintain.svg )
2021-02-22 23:27:16 +01:00
[![Install Matomo with YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=matomo)
2019-07-01 22:17:06 +02:00
2020-12-09 10:32:09 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2021-07-10 18:27:01 +02:00
> *This package allows you to install Matomo quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
2018-10-30 10:25:13 +01:00
2019-07-01 22:17:06 +02:00
## Overview
2018-10-30 10:25:13 +01:00
2022-04-27 14:52:20 +02:00
Matomo is the leading Free/Libre open analytics platform.
2019-07-01 22:17:06 +02:00
2022-04-27 14:52:20 +02:00
Matomo is a full-featured PHP MySQL software program that you download and install on your own webserver. At the end of the five-minute installation process, you will be given a JavaScript code. Simply copy and paste this tag on websites you wish to track and access your analytics reports in real-time.
Matomo aims to be a Free software alternative to Google Analytics and is already used on more than 1,400,000 websites. Privacy is built-in!
2023-01-27 12:17:51 +01:00
**Shipped version:** 4.13.2~ynh1
2019-07-01 22:17:06 +02:00
2021-07-10 18:27:01 +02:00
**Demo:** https://demo.matomo.org
2019-07-01 22:17:06 +02:00
2021-07-10 18:27:01 +02:00
## Screenshots
2019-07-01 22:17:06 +02:00
2022-05-26 09:54:17 +02:00
![Screenshot of Matomo ](./doc/screenshots/screenshot.png )
2021-07-10 18:27:01 +02:00
## Disclaimers / important information
2018-10-30 10:25:13 +01:00
## Configuration
2019-07-01 22:17:06 +02:00
2018-11-01 00:10:43 +01:00
1. The app will require to complete the registration process after the instllation is complete by **visiting the domain** on which Matomo is installed.
2020-09-13 17:38:08 +02:00
1. The MySQL database credentials will be sent to the **admin mail** . Fill these details while doing the registration process.
1. No LDAP support yet for the app.
2018-10-30 10:25:13 +01:00
2021-07-10 18:27:01 +02:00
## Documentation and resources
2018-10-30 10:25:13 +01:00
2022-05-26 09:54:17 +02:00
* Official app website: < https: // matomo . org >
* Official admin documentation: < https: // matomo . org / docs >
* Upstream app code repository: < https: // github . com / matomo-org / matomo >
* YunoHost documentation for this app: < https: // yunohost . org / app_matomo >
* Report a bug: < https: // github . com / YunoHost-Apps / matomo_ynh / issues >
2018-10-30 10:25:13 +01:00
2020-09-13 17:38:08 +02:00
## Developer info
2018-10-30 10:25:13 +01:00
2020-05-31 00:00:08 +02:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/matomo_ynh/tree/testing ).
2019-07-01 22:17:06 +02:00
To try the testing branch, please proceed like that.
2022-05-26 09:54:17 +02:00
``` bash
2019-07-01 22:17:06 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/matomo_ynh/tree/testing --debug
or
sudo yunohost app upgrade matomo -u https://github.com/YunoHost-Apps/matomo_ynh/tree/testing --debug
2018-10-30 10:25:13 +01:00
```
2021-07-10 18:27:01 +02:00
2022-05-26 09:54:17 +02:00
**More info regarding app packaging:** < https: / / yunohost . org / packaging_apps >