Skip to content
Normal view History Permalink
README.md 2.17 KiB
Newer Older
Pierre Ozoux's avatar
Moves compose here  
Pierre Ozoux committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 
# Piwik

[![Build Status](https://travis-ci.org/piwik/docker-piwik.svg?branch=master)](https://travis-ci.org/piwik/docker-piwik)

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](https://rawgit.com/piwik/docker-piwik/master/logo.svg)

# How to use this image

The easiest is to use our `docker-compose.yml`.

Make sure you have [docker-compose](http://docs.docker.com/compose/install/) installed. And then:

```bash
git clone https://github.com/indiehosters/piwik.git
Pierre Ozoux's avatar
gives some :heart:  
Pierre Ozoux committed
23 24 
cd piwik
MYSQL_ROOT_PASSWORD=mystrongpassword docker-compose up
Pierre Ozoux's avatar
Moves compose here  
Pierre Ozoux committed
25 26 27 28 29 30 
```

You can now access your instance on the port 80 of the IP of your machine (not recommended for production).

## Access it from Internet
Pierre Ozoux's avatar
gives some :heart:  
Pierre Ozoux committed
31 32 
We recommend the usage of SSL, so the easiest is to use a TLS capable reverse proxy.
Here are 2 examples:
Pierre Ozoux's avatar
Moves compose here  
Pierre Ozoux committed
33
Pierre Ozoux's avatar
gives some :heart:  
Pierre Ozoux committed
34 35 
 - [haproxy](https://github.com/indiehosters/haproxy)
 - [nginx](https://github.com/indiehosters/nginx)
Pierre Ozoux's avatar
Moves compose here  
Pierre Ozoux committed
36
Pierre Ozoux's avatar
gives some :heart:  
Pierre Ozoux committed
37 
You can also modify manually the nginx configuration file and map the TLS port of the host to the container.
Pierre Ozoux's avatar
Moves compose here  
Pierre Ozoux committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 

## Installation

Once started, you'll arrive at the configuration wizard.
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.

## Emails

The recommended way is to use the `ssmtp` shipped with the image.
To use it, just run:

```
export MAIL_USER=myname@gmail.com
export MAIL_PASS=mypass
export MAIL_HOST=mail.google.com
export MAIL_PORT=587
./install
```

## Backup
Pierre Ozoux's avatar
gives some :heart:  
Pierre Ozoux committed
68 
In order to backup, just run the `./pre-backup` script. And copy all the data to a safe place.
Pierre Ozoux's avatar
Moves compose here  
Pierre Ozoux committed
69 70 71 72 73 74 75 76 77 78 79 

## Contribute

Pull requests are very welcome!

We'd love to hear your feedback and suggestions in the issue tracker: [github.com/indiehosters/piwik/issues](https://github.com/indiehosters/piwik/issues).

## GeoIP

This product includes GeoLite data created by MaxMind, available from
[http://www.maxmind.com](http://www.maxmind.com).