diff --git a/matomo/README-short.txt b/matomo/README-short.txt new file mode 100644 index 000000000..5fd11362a --- /dev/null +++ b/matomo/README-short.txt @@ -0,0 +1 @@ +Matomo is the leading open-source analytics platform that gives you more than powerful analytics. diff --git a/matomo/content.md b/matomo/content.md new file mode 100644 index 000000000..72809743c --- /dev/null +++ b/matomo/content.md @@ -0,0 +1,60 @@ +# Matomo (formerly Piwik) + +[![Build Status](https://travis-ci.org/matomo-org/docker.svg?branch=master)](https://travis-ci.org/matomo-org/docker) [Matomo](https://matomo.org/) (formerly Piwik) is the leading open-source analytics platform that gives you more than just powerful analytics: + +- Free open-source software +- 100% data ownership +- User privacy protection +- User-centric insights +- Customisable and extensible + +%%LOGO%% + +## Usage + +In keeping with a 'pure' micro-services approach, this image runs a Matomo service only (in the form of FastCGI). Because of that it **must** be used with companion containers which provide a database for data storage and HTTP to FastCGI proxy/translation services for the user interface. + +## Runtime + +You can run the Matomo container and service like so: + +```console +docker run -d --link some-mysql:db matomo +``` + +This assumes you've already launched a suitable MySQL or MariaDB database container. + +You'll now need to use a suitable reverse proxy to access the user interface; which is available on TCP port 9000. Nginx provides the necessary functions for translation between HTTP and FastCGI. + +## Matomo Installation + +Once you're up and running, you'll arrive at the configuration wizard page. If you're using the compose file, at the `Database Setup` step, please enter the following: + +- Database Server: `db` +- Login: `root` +- Password: MYSQL_ROOT_PASSWORD +- Database Name: piwik (or you can choose) + +And leave the rest as default. + +Then you can continue the installation with the super user. + +## Docker-compose examples and log import instructions + +A minimal set-up using docker-compose is available in the [.examples folder](https://github.com/matomo-org/docker/tree/master/.examples). + +If you want to use the import logs script, you can then run the following container as needed, in order to execute the python import logs script: + +```console +docker run --rm --volumes-from="matomo_app_1" --link matomo_app_1 python:2-alpine python /var/www/html/misc/log-analytics/import_logs.py --url=http://ip.of.your.piwik --login=yourlogin --password=yourpassword --idsite=1 --recorders=4 /var/www/html/logs/access.log +``` + +## Contribute + +Pull requests are very welcome! + +We'd love to hear your feedback and suggestions in the issue tracker: [github.com/motomo-org/docker/issues](https://github.com/matomo-org/docker/issues). + +## GeoIP + +This product includes GeoLite data created by MaxMind, available from [http://www.maxmind.com](http://www.maxmind.com). diff --git a/matomo/github-repo b/matomo/github-repo new file mode 100644 index 000000000..df9b94c71 --- /dev/null +++ b/matomo/github-repo @@ -0,0 +1 @@ +https://github.com/matomo-org/docker diff --git a/matomo/license.md b/matomo/license.md new file mode 100644 index 000000000..ccfaebd94 --- /dev/null +++ b/matomo/license.md @@ -0,0 +1 @@ +View [license information](https://github.com/matomo-org/matomo/blob/master/LEGALNOTICE) for the software contained in this image. diff --git a/matomo/logo.png b/matomo/logo.png new file mode 100644 index 000000000..79315acbd Binary files /dev/null and b/matomo/logo.png differ diff --git a/matomo/maintainer.md b/matomo/maintainer.md new file mode 100644 index 000000000..e5b3202ba --- /dev/null +++ b/matomo/maintainer.md @@ -0,0 +1 @@ +[Matomo](%%GITHUB-REPO%%) (a Matomo community contributor) diff --git a/piwik/deprecated.md b/piwik/deprecated.md new file mode 100644 index 000000000..98a1b4152 --- /dev/null +++ b/piwik/deprecated.md @@ -0,0 +1 @@ +This image is officially deprecated in favor of [the `matomo` image](https://hub.docker.com/_/matomo/), and will receive no further updates after 2018-09-30 (Sep 30, 2018). Please adjust your usage accordingly.