Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Readme formatting
  • Loading branch information
jbrule authored Feb 12, 2019
1 parent 866fc99 commit 6f38fdf
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Matomo SiteAccessProvisioner Plugin

##Description
## Description
Plugin for the Matomo Web Analytics software package that facilitates an easy process to grant users access to site reports. A companion access provider is required, usually in the form of a website CMS plugin/module (you may need to build this if one does not exist).

##Instructions
## Instructions
The easiest way to install is to find the plugin in the [Matomo Marketplace](https://plugins.matomo.org/).
A shared secret must be etablished before the plugin will function.
You will then need to implement an access provider (see example code below) which will generate an access request link users can use.

##Usage
## Usage

Implementation code for access provider. Should be trivial to port to other languages.
```php
Expand All @@ -20,7 +20,7 @@ $token = hash('sha256', implode('',[$sharedSecret, $idUser, $site, $timestamp]))

$linkHref = sprintf("http://matomoinstall.example.com/matomo/index.php?%s", http_build_query(["module"=>"SiteAccessProvisioner", "action"=>"accessRequest", "idUser"=>$idUser, "site"=>$site, "timestamp"=>$timestamp, "token"=>$token]));
```
##License
## License
GPL v3 / fair use

## Support
Expand Down

0 comments on commit 6f38fdf

Please sign in to comment.