Skip to content
This repository was archived by the owner on Aug 3, 2022. It is now read-only.

Commit 2e73e6c

Browse files
committed
Updates readme and composer.lock
1 parent 86d0fc9 commit 2e73e6c

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
1-
# Piwik on Heroku, Dokku, or Flynn
1+
# Matomo (aka Piwik) on Heroku, Dokku, or Flynn
2+
3+
Even though the application has been renamed from Piwik to Matomo, the most of the composer packages are still namespaced using `piwik`. This is being updated for Matomo 4 (https://github.com/matomo-org/matomo/issues/12519).
24

35
## Installation
46

57
1. Create a new app.
68
2. Connect a mysql database to the app.
7-
3. Update database connection in `config.ini.php` as needed
8-
4. Add config settings for `SALT` and `TRUSTED_HOST` (the domain name you access the piwik app from)
9+
3. Update config for database connection in `config.ini.php` as needed
10+
4. Add config settings for `SALT` and `TRUSTED_HOST` (the domain name you access the Matomo app from)
911
5. Deploy app
1012

1113
## Config
1214

13-
The filesystem is ephemeral and will be wiped out on each deploy. Any settings that piwik automatically updates in `vendor/piwik/piwik/config/config.ini.php` need to be manually duplicated in the `config.ini.php` in the repo, or they will be wiped out the next time the app is rebuilt.
15+
The filesystem is ephemeral and will be wiped out on each deploy. Any settings that Matomo automatically updates in `vendor/piwik/piwik/config/config.ini.php` need to be manually duplicated in the `config.ini.php` in the repo, or they will be wiped out the next time the app is rebuilt.
1416

1517
## Plugins
1618

17-
Plugins are managed by composer. Plugins installed through piwik's web interface will get erased when the app is rebuilt.
19+
Plugins are managed by composer. Plugins installed through Matomo's web interface will get erased when the app is rebuilt.
1820

19-
Most piwik plugins do not include a composer.json file so you'll need to use the package option and define the settings for each plugin manually. See the configuration for the SecurityInfo plugin in `composer.json` for an example. By sure that `"type": "piwik-plugin"` is defined in the plugins package.json file.
21+
Most Matomo plugins do not include a composer.json file so you'll need to use the package option and define the settings for each plugin manually. See the configuration for the SecurityInfo plugin in `composer.json` for an example. By sure that `"type": "piwik-plugin"` is defined in the plugins package.json file.
2022

2123
1. `composer require [plugin]` to install the plugin
2224
2. Add plugin to `Plugins[]` and `PluginsInstalled[]` lists in `config.ini.php` so that the plugin is activated when the app is re-deployed.
2325

2426
## GeoIP
2527

26-
This setup is configured to use the [GeoIP2 Plugin](https://github.com/diabl0/piwik-geoip2). The GeoLite databases are provided by a custom buildpack https://github.com/danstiner/heroku-buildpack-geoip-geolite2 defined in `.buildpacks`.
28+
This setup is configured to use the GeoIp2 plugin included in the core Matomo package. The GeoLite databases are downloaded using a custom buildpack https://github.com/danstiner/heroku-buildpack-geoip-geolite2 defined in `.buildpacks`.
2729

28-
You can turn on this geolocation method on in Settings > System > Geolocation. Rebuilding the app will get a fresh copy of the GeoLite databases.
30+
You can turn on this geolocation method on in Settings > System > Geolocation. Rebuilding the app will get a fresh copy of the GeoLite databases. You can also configure the plugin to download an updated database periodically.
2931

3032
## Heroku
3133

composer.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)