Merge pull request #15 from digitalist-se/fix_readme_on-install_instr…

…uctions Update README.md
Digitalist-Open-Cloud · May 6, 2024 · 11542a9 · 11542a9
2 parents 9129f14 + 5e940fe
commit 11542a9
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change log
 
+## [5.0.14] - 2024-05-06
+
+### Changed
+
+- Install instructions in `README.md` - mirrored in `docs/index.md`
+
 ## 5.0.9
 
 - Fix bug in 5.0.8 that broke Matomo.

diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Log errors from Matomo to a [Sentry](https://sentry.io/) instance, or Sentry com
 ## Installation
 
 * Clone GitHub repo into plugins/Sentry.
-* Go into root for your Matomo project (/var/www/html).
+* Go into plugins/Sentry.
 * Run composer install --no-dev for productions use.
 * Install Sentry plugin in Matomo.
 * Go to settings page for adding the adding the Sentry Data Source Name (DSN).

diff --git a/docs/index.md b/docs/index.md
@@ -2,15 +2,19 @@
 
 ## Description
 
-Log errors from Matomo to a [Sentry](https://sentry.io/) instance, or Sentry compatible setup like [GlitchTip](https://glitchtip.com/).
+Log errors from Matomo to a [Sentry](https://sentry.io/) instance, or Sentry compatible setup like [GlitchTip](https://glitchtip.com/). [Here is a guide](https://guides.lw1.at/how-to-install-glitchtip-without-docker/) by [@Findus23](https://github.com/Findus23) on how to setup GlitchTip if you are not using Docker.
+
+> [!WARNING]
+> With this plugin activated, the data of the logged in user could be logged in Sentry, handle all user data with care, and make sure you are using settings that anonymize the data.
 
 ## Installation
 
-* Clone github repo into plugins/Sentry.
+* Clone GitHub repo into plugins/Sentry.
 * Go into plugins/Sentry.
 * Run composer install --no-dev for productions use.
 * Install Sentry plugin in Matomo.
 * Go to settings page for adding the adding the Sentry Data Source Name (DSN).
+* Adjust Error tracking sample rate and Tracing sample rate to you preferred values.
 * Save settings.
 
 ## Settings

diff --git a/plugin.json b/plugin.json
@@ -1,7 +1,7 @@
 {
   "name": "Sentry",
   "description": "Log Matomo errors to Sentry",
-  "version": "5.0.13",
+  "version": "5.0.14",
   "theme": false,
   "require": {
     "matomo": ">=5.0.0-stable,<6.0.0-b1",