matomo_ynh/README.md

<!--
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.
-->

# Matomo for YunoHost

[![Integration level](https://dash.yunohost.org/integration/matomo.svg)](https://dash.yunohost.org/appci/app/matomo) ![](https://ci-apps.yunohost.org/ci/badges/matomo.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/matomo.maintain.svg)  
[![Install Matomo with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matomo)

*[Lire ce readme en français.](./README_fr.md)*

> *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.*

## Overview

Open source analytics platform for measuring Web statistics

**Shipped version:** 4.6.0~ynh1

**Demo:** https://demo.matomo.org

## Screenshots

![](./doc/screenshots/screenshot.png)

## Disclaimers / important information

## Configuration

1. The app will require to complete the registration process after the instllation is complete by **visiting the domain** on  which Matomo is installed.
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.

## Documentation and resources

* 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

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/matomo_ynh/tree/testing).

To try the testing branch, please proceed like that.
```
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
```

**More info regarding app packaging:** https://yunohost.org/packaging_apps
Auto-update README 2021-07-08 08:11:42 +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.`
			`-->`

Update README.md 2020-06-19 22:18:51 +02:00			`# Matomo for YunoHost`
First commit 2018-10-30 10:25:13 +01:00
Apply example_ynh 2020-05-31 00:00:08 +02:00			`[![Integration level](https://dash.yunohost.org/integration/matomo.svg)](https://dash.yunohost.org/appci/app/matomo) ![](https://ci-apps.yunohost.org/ci/badges/matomo.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/matomo.maintain.svg)`
Update README.md 2020-12-17 21:46:13 +01:00			`[![Install Matomo with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matomo)`
Apply example_ynh 2019-07-01 22:17:06 +02:00
Update README.md 2020-12-09 09:56:25 +01:00			`[Lire ce readme en français.](./README_fr.md)`

Auto-update README 2021-07-08 08:11:42 +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.*`
First commit 2018-10-30 10:25:13 +01:00
Apply example_ynh 2019-07-01 22:17:06 +02:00			`## Overview`
First commit 2018-10-30 10:25:13 +01:00
Auto-update README 2021-07-08 08:11:42 +02:00			`Open source analytics platform for measuring Web statistics`
Apply example_ynh 2019-07-01 22:17:06 +02:00
Auto-update README 2021-11-30 07:30:18 +01:00			`Shipped version: 4.6.0~ynh1`
Apply example_ynh 2019-07-01 22:17:06 +02:00
Auto-update README 2021-07-08 08:11:42 +02:00			`Demo: https://demo.matomo.org`
Apply example_ynh 2019-07-01 22:17:06 +02:00
Auto-update README 2021-07-08 08:11:42 +02:00			`## Screenshots`
Apply example_ynh 2019-07-01 22:17:06 +02:00
Auto-update README 2021-07-08 08:11:42 +02:00			`![](./doc/screenshots/screenshot.png)`

			`## Disclaimers / important information`
First commit 2018-10-30 10:25:13 +01:00
			`## Configuration`
Apply example_ynh 2019-07-01 22:17:06 +02:00
Updated readme 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.`
Upgrade to 3.14.1 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.`
First commit 2018-10-30 10:25:13 +01:00
Auto-update README 2021-07-08 08:11:42 +02:00			`## Documentation and resources`
First commit 2018-10-30 10:25:13 +01:00
Auto-update README 2021-07-08 08:11:42 +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`
First commit 2018-10-30 10:25:13 +01:00
Upgrade to 3.14.1 2020-09-13 17:38:08 +02:00			`## Developer info`
First commit 2018-10-30 10:25:13 +01:00
Apply example_ynh 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).`
Apply example_ynh 2019-07-01 22:17:06 +02:00
			`To try the testing branch, please proceed like that.`
			```
			`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`
First commit 2018-10-30 10:25:13 +01:00			```
Auto-update README 2021-07-08 08:11:42 +02:00
			`More info regarding app packaging: https://yunohost.org/packaging_apps`