Skip to content

Commit 955ef68

Browse files
pierreozouxtianon
authored andcommitted
Add matomo documentation
1 parent b0f8db2 commit 955ef68

File tree

6 files changed

+64
-0
lines changed

6 files changed

+64
-0
lines changed

matomo/README-short.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Matomo is the leading open-source analytics platform that gives you more than powerful analytics.

matomo/content.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Matomo (formerly Piwik)
2+
3+
[![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:
4+
5+
- Free open-source software
6+
- 100% data ownership
7+
- User privacy protection
8+
- User-centric insights
9+
- Customisable and extensible
10+
11+
%%LOGO%%
12+
13+
## Usage
14+
15+
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.
16+
17+
## Runtime
18+
19+
You can run the Matomo container and service like so:
20+
21+
```console
22+
docker run -d --link some-mysql:db matomo
23+
```
24+
25+
This assumes you've already launched a suitable MySQL or MariaDB database container.
26+
27+
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.
28+
29+
## Matomo Installation
30+
31+
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:
32+
33+
- Database Server: `db`
34+
- Login: `root`
35+
- Password: MYSQL_ROOT_PASSWORD
36+
- Database Name: piwik (or you can choose)
37+
38+
And leave the rest as default.
39+
40+
Then you can continue the installation with the super user.
41+
42+
## Docker-compose examples and log import instructions
43+
44+
A minimal set-up using docker-compose is available in the [.examples folder](https://github.com/matomo-org/docker/tree/master/.examples).
45+
46+
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:
47+
48+
```console
49+
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
50+
```
51+
52+
## Contribute
53+
54+
Pull requests are very welcome!
55+
56+
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).
57+
58+
## GeoIP
59+
60+
This product includes GeoLite data created by MaxMind, available from [http://www.maxmind.com](http://www.maxmind.com).

matomo/github-repo

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
https://github.com/matomo-org/docker

matomo/license.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
View [license information](https://github.com/matomo-org/matomo/blob/master/LEGALNOTICE) for the software contained in this image.

matomo/logo.png

20.3 KB
Loading

matomo/maintainer.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[Matomo](%%GITHUB-REPO%%) (a Matomo community contributor)

0 commit comments

Comments
 (0)