soderlind · March 14, 2025 22:53 · Jun 10, 2024 · Jun 7, 2024 · Jun 5, 2024 · Jun 5, 2024
diff --git a/readme.md b/readme.md
@@ -46,7 +46,7 @@ Learn more at https://github.com/stayallive/wp-sentry/tree/v7.13.0?tab=readme-ov
 </details>
 
 ### Send emails to Buggregator
-Save [mu-buggregator-smtp.php](#file-mu-buggregator-smtp-php) in your `mu-plugins` folder
+Save [`mu-buggregator-smtp.php`](#file-mu-buggregator-smtp-php) in your `mu-plugins` folder
 
 <details>
   <summary>Example: Email</summary>

diff --git a/readme.md b/readme.md
@@ -4,7 +4,8 @@
 0.  (You need [docker](https://www.docker.com/products/docker-desktop/))
 1. Save the [`docker-compose.yml`](#file-docker-compose-yml) file.
 2. Run `docker-compose up` in the same folder as the `docker-compose.yml` file.
-3. Buggregator is at http://127.0.0.1:8000/#/
+	- Update buggregator by running `docker-compose pull`
+4. Buggregator is at http://127.0.0.1:8000/#/
 
 Learn more at https://docs.buggregator.dev/
 

diff --git a/mu-buggregator-smtp.php b/mu-buggregator-smtp.php
@@ -20,6 +20,6 @@
  */
 add_action( 'phpmailer_init', function( $phpmailer ) : void {
 	$phpmailer->isSMTP();     
-    $phpmailer->Host = '127.0.0.1';
-    $phpmailer->Port = 1025;
+	$phpmailer->Host = '127.0.0.1';
+	$phpmailer->Port = 1025;
 }  );
diff --git a/readme.md b/readme.md
@@ -45,4 +45,9 @@ Learn more at https://github.com/stayallive/wp-sentry/tree/v7.13.0?tab=readme-ov
 </details>
 
 ### Send emails to Buggregator
-Save [mu-buggregator-smtp.php](#file-mu-buggregator-smtp-php) in your `mu-plugins` folder
+Save [mu-buggregator-smtp.php](#file-mu-buggregator-smtp-php) in your `mu-plugins` folder
+
+<details>
+  <summary>Example: Email</summary>
+<img width="727" alt="mail" src="https://gist.github.com/assets/1649452/a6c0ec2e-a632-4252-a20e-ebe878610cf1">
+</details>
diff --git a/readme.md b/readme.md
@@ -1,4 +1,4 @@
-# Buggregator for WordPress local development
+# Buggregator for local WordPress development
 ## Buggregator
 
 0.  (You need [docker](https://www.docker.com/products/docker-desktop/))

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -5,7 +5,8 @@ services:
             buggregator-database:
                 condition: service_healthy
         ports:
-            - 127.0.0.1:8000:8000
+            - 127.0.0.1:8000:8000 # Sentry, Ray
+            - 127.0.0.1:1025:1025 # SMTP
         environment:
             PERSISTENCE_DRIVER: database
             DB_DRIVER: pgsql

diff --git a/readme.md b/readme.md
@@ -42,4 +42,7 @@ Learn more at https://github.com/stayallive/wp-sentry/tree/v7.13.0?tab=readme-ov
 <details>
   <summary>Example: Variable dump</summary>
 <img width="1037" alt="ray" src="https://gist.github.com/assets/1649452/951d92a8-f1c2-466b-9c44-414b5351c436">
-</details>
+</details>
+
+### Send emails to Buggregator
+Save [mu-buggregator-smtp.php](#file-mu-buggregator-smtp-php) in your `mu-plugins` folder
diff --git a/mu-buggregator-smtp.php b/mu-buggregator-smtp.php
@@ -0,0 +1,25 @@
+<?php
+/**
+ * Plugin Name: MU Buggregator SMTP
+ * Description: Send email to Buggregator. Will only log errors if WP_ENVIRONMENT_TYPE is set to 'local'.
+ * Version: 1.0.0
+ * Author: PerS
+ * Author URI: https://www.soderlind.no/
+ * License: GPL-2.0+
+ * License URI: http://www.gnu.org/licenses/gpl-2.0.txt
+ */
+
+if (! defined('WP_ENVIRONMENT_TYPE') || 'local' !== WP_ENVIRONMENT_TYPE) {
+	return;
+}
+
+/**
+ * Send emails to Buggregator
+ *
+ * @param \PHPMailer $phpmailer The PHPMailer instance (passed by reference).
+ */
+add_action( 'phpmailer_init', function( $phpmailer ) : void {
+	$phpmailer->isSMTP();     
+    $phpmailer->Host = '127.0.0.1';
+    $phpmailer->Port = 1025;
+}  );
diff --git a/readme.md b/readme.md
@@ -1,4 +1,4 @@
-
+# Buggregator for WordPress local development
 ## Buggregator
 
 0.  (You need [docker](https://www.docker.com/products/docker-desktop/))

diff --git a/readme.md b/readme.md
@@ -25,6 +25,8 @@ if ( defined( 'WP_ENVIRONMENT_TYPE' ) && 'local' === WP_ENVIRONMENT_TYPE ) {
 	require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php';
 }
 ```
+Learn more at https://github.com/stayallive/wp-sentry/tree/v7.13.0?tab=readme-ov-file#usage
+
 <details>
   <summary>Example: Exeception</summary>
 <img width="878" alt="sentry" src="https://gist.github.com/assets/1649452/b70eb538-f521-45e2-b072-366127fc8a61">

diff --git a/readme.md b/readme.md
@@ -26,7 +26,7 @@ if ( defined( 'WP_ENVIRONMENT_TYPE' ) && 'local' === WP_ENVIRONMENT_TYPE ) {
 }
 ```
 <details>
-  <summary>Exeception</summary>
+  <summary>Example: Exeception</summary>
 <img width="878" alt="sentry" src="https://gist.github.com/assets/1649452/b70eb538-f521-45e2-b072-366127fc8a61">
 </details>
 
@@ -38,6 +38,6 @@ if ( defined( 'WP_ENVIRONMENT_TYPE' ) && 'local' === WP_ENVIRONMENT_TYPE ) {
 
 
 <details>
-  <summary>Variable dump</summary>
+  <summary>Example: Variable dump</summary>
 <img width="1037" alt="ray" src="https://gist.github.com/assets/1649452/951d92a8-f1c2-466b-9c44-414b5351c436">
 </details>
diff --git a/readme.md b/readme.md
@@ -25,17 +25,19 @@ if ( defined( 'WP_ENVIRONMENT_TYPE' ) && 'local' === WP_ENVIRONMENT_TYPE ) {
 	require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php';
 }
 ```
-Example exeception:
-
+<details>
+  <summary>Exeception</summary>
 <img width="878" alt="sentry" src="https://gist.github.com/assets/1649452/b70eb538-f521-45e2-b072-366127fc8a61">
-
+</details>
 
 
 ### Dump stuff using ray
 1. Install ray in your project using composer: `composer --dev require spatie/ray`
 2. Copy [`ray.php`](#file-ray-php) to the root of your WordPress site 
 3. Now you can [dump to buggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
 
-Example variable dump:
 
+<details>
+  <summary>Variable dump</summary>
 <img width="1037" alt="ray" src="https://gist.github.com/assets/1649452/951d92a8-f1c2-466b-9c44-414b5351c436">
+</details>
diff --git a/readme.md b/readme.md
@@ -16,9 +16,10 @@ Learn more at https://docs.buggregator.dev/
 1. Install [WP Sentry](https://wordpress.org/plugins/wp-sentry-integration/). You don't have to activate it. We will [load it early](https://github.com/stayallive/wp-sentry/tree/v7.13.0?tab=readme-ov-file#loading-sentry-before-wordpress), to catch errors early.
 2. In `wp-config.php` add:
 ```php
-// NOTE: WP_ENVIRONMENT_TYPE must be defined and set to 'local'.
+// NOTE: WP_ENVIRONMENT_TYPE must be defined and set to 'local'. Uncomment the line below if it's not set by the server
+// define( 'WP_ENVIRONMENT_TYPE', 'local' );
 
-if (defined('WP_ENVIRONMENT_TYPE') && 'local' === WP_ENVIRONMENT_TYPE) {
+if ( defined( 'WP_ENVIRONMENT_TYPE' ) && 'local' === WP_ENVIRONMENT_TYPE ) {
 	define( 'WP_SENTRY_PHP_DSN', 'http://[email protected]:8000/1' );
 	define( 'WP_SENTRY_ERROR_TYPES', E_ALL & ~E_NOTICE & ~E_USER_NOTICE );
 	require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php';

diff --git a/readme.md b/readme.md
@@ -35,6 +35,6 @@ Example exeception:
 2. Copy [`ray.php`](#file-ray-php) to the root of your WordPress site 
 3. Now you can [dump to buggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
 
-Example varible dump:
+Example variable dump:
 
 <img width="1037" alt="ray" src="https://gist.github.com/assets/1649452/951d92a8-f1c2-466b-9c44-414b5351c436">
diff --git a/readme.md b/readme.md
@@ -3,7 +3,7 @@
 
 0.  (You need [docker](https://www.docker.com/products/docker-desktop/))
 1. Save the [`docker-compose.yml`](#file-docker-compose-yml) file.
-2. Run `docker-compose up`
+2. Run `docker-compose up` in the same folder as the `docker-compose.yml` file.
 3. Buggregator is at http://127.0.0.1:8000/#/
 
 Learn more at https://docs.buggregator.dev/

diff --git a/readme.md b/readme.md
@@ -24,6 +24,8 @@ if (defined('WP_ENVIRONMENT_TYPE') && 'local' === WP_ENVIRONMENT_TYPE) {
 	require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php';
 }
 ```
+Example exeception:
+
 <img width="878" alt="sentry" src="https://gist.github.com/assets/1649452/b70eb538-f521-45e2-b072-366127fc8a61">
 
 
@@ -33,4 +35,6 @@ if (defined('WP_ENVIRONMENT_TYPE') && 'local' === WP_ENVIRONMENT_TYPE) {
 2. Copy [`ray.php`](#file-ray-php) to the root of your WordPress site 
 3. Now you can [dump to buggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
 
+Example varible dump:
+
 <img width="1037" alt="ray" src="https://gist.github.com/assets/1649452/951d92a8-f1c2-466b-9c44-414b5351c436">
diff --git a/readme.md b/readme.md
@@ -2,10 +2,9 @@
 ## Buggregator
 
 0.  (You need [docker](https://www.docker.com/products/docker-desktop/))
-1. Follow the instalation guide at https://buggregator.dev/#install
-2. Save the [`docker-compose.yml`](#file-docker-compose-yml) file.
-3. Run `docker-compose up`
-4. Buggregator is at http://127.0.0.1:8000/#/
+1. Save the [`docker-compose.yml`](#file-docker-compose-yml) file.
+2. Run `docker-compose up`
+3. Buggregator is at http://127.0.0.1:8000/#/
 
 Learn more at https://docs.buggregator.dev/
 

diff --git a/readme.md b/readme.md
@@ -1,7 +1,7 @@
 
 ## Buggregator
 
-0.  (You need docker)
+0.  (You need [docker](https://www.docker.com/products/docker-desktop/))
 1. Follow the instalation guide at https://buggregator.dev/#install
 2. Save the [`docker-compose.yml`](#file-docker-compose-yml) file.
 3. Run `docker-compose up`

diff --git a/readme.md b/readme.md
@@ -7,6 +7,8 @@
 3. Run `docker-compose up`
 4. Buggregator is at http://127.0.0.1:8000/#/
 
+Learn more at https://docs.buggregator.dev/
+
 ## WordPress
 
 > Make sure `WP_ENVIRONMENT_TYPE`is set to `local`. [Local](https://localwp.com/) (by WPEngine) does that by default.

diff --git a/readme.md b/readme.md
@@ -5,6 +5,7 @@
 1. Follow the instalation guide at https://buggregator.dev/#install
 2. Save the [`docker-compose.yml`](#file-docker-compose-yml) file.
 3. Run `docker-compose up`
+4. Buggregator is at http://127.0.0.1:8000/#/
 
 ## WordPress
 

diff --git a/readme.md b/readme.md
@@ -31,4 +31,4 @@ if (defined('WP_ENVIRONMENT_TYPE') && 'local' === WP_ENVIRONMENT_TYPE) {
 2. Copy [`ray.php`](#file-ray-php) to the root of your WordPress site 
 3. Now you can [dump to buggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
 
-<img width="977" alt="ray" src="https://gist.github.com/assets/1649452/dfd7a2b1-e9f9-4a1a-a8c2-81edcea16127">
+<img width="1037" alt="ray" src="https://gist.github.com/assets/1649452/951d92a8-f1c2-466b-9c44-414b5351c436">
diff --git a/readme.md b/readme.md
@@ -1,3 +1,4 @@
+
 ## Buggregator
 
 0.  (You need docker)
@@ -21,8 +22,13 @@ if (defined('WP_ENVIRONMENT_TYPE') && 'local' === WP_ENVIRONMENT_TYPE) {
 	require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php';
 }
 ```
+<img width="878" alt="sentry" src="https://gist.github.com/assets/1649452/b70eb538-f521-45e2-b072-366127fc8a61">
+
+
 
 ### Dump stuff using ray
 1. Install ray in your project using composer: `composer --dev require spatie/ray`
 2. Copy [`ray.php`](#file-ray-php) to the root of your WordPress site 
-3. Now you can [dump to buggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
+3. Now you can [dump to buggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
+
+<img width="977" alt="ray" src="https://gist.github.com/assets/1649452/dfd7a2b1-e9f9-4a1a-a8c2-81edcea16127">
diff --git a/readme.md b/readme.md
@@ -10,7 +10,7 @@
 > Make sure `WP_ENVIRONMENT_TYPE`is set to `local`. [Local](https://localwp.com/) (by WPEngine) does that by default.
 
 ### Log errors using WP Sentry
-1. Install [WP Sentry](https://wordpress.org/plugins/wp-sentry-integration/)
+1. Install [WP Sentry](https://wordpress.org/plugins/wp-sentry-integration/). You don't have to activate it. We will [load it early](https://github.com/stayallive/wp-sentry/tree/v7.13.0?tab=readme-ov-file#loading-sentry-before-wordpress), to catch errors early.
 2. In `wp-config.php` add:
 ```php
 // NOTE: WP_ENVIRONMENT_TYPE must be defined and set to 'local'.

diff --git a/readme.md b/readme.md
@@ -2,12 +2,12 @@
 
 0.  (You need docker)
 1. Follow the instalation guide at https://buggregator.dev/#install
-2. Save the [`docker-compose.yml`](#file-docker-compose-yml)
+2. Save the [`docker-compose.yml`](#file-docker-compose-yml) file.
 3. Run `docker-compose up`
 
 ## WordPress
 
-> Make sure `WP_ENVIRONMENT_TYPE`is set to `local`
+> Make sure `WP_ENVIRONMENT_TYPE`is set to `local`. [Local](https://localwp.com/) (by WPEngine) does that by default.
 
 ### Log errors using WP Sentry
 1. Install [WP Sentry](https://wordpress.org/plugins/wp-sentry-integration/)

diff --git a/ray.php b/ray.php
@@ -1,4 +1,7 @@
 <?php
+if ( ! defined( 'WP_ENVIRONMENT_TYPE' ) || 'local' !== WP_ENVIRONMENT_TYPE ) {
+	return;
+}
 
 
 return [

diff --git a/readme.md b/readme.md
@@ -6,13 +6,20 @@
 3. Run `docker-compose up`
 
 ## WordPress
+
+> Make sure `WP_ENVIRONMENT_TYPE`is set to `local`
+
 ### Log errors using WP Sentry
 1. Install [WP Sentry](https://wordpress.org/plugins/wp-sentry-integration/)
 2. In `wp-config.php` add:
 ```php
-define( 'WP_SENTRY_PHP_DSN', 'http://[email protected]:8000/1' );
-define( 'WP_SENTRY_ERROR_TYPES', E_ALL & ~E_NOTICE & ~E_USER_NOTICE );
-require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php';
+// NOTE: WP_ENVIRONMENT_TYPE must be defined and set to 'local'.
+
+if (defined('WP_ENVIRONMENT_TYPE') && 'local' === WP_ENVIRONMENT_TYPE) {
+	define( 'WP_SENTRY_PHP_DSN', 'http://[email protected]:8000/1' );
+	define( 'WP_SENTRY_ERROR_TYPES', E_ALL & ~E_NOTICE & ~E_USER_NOTICE );
+	require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php';
+}
 ```
 
 ### Dump stuff using ray

diff --git a/readme.md b/readme.md
@@ -2,7 +2,7 @@
 
 0.  (You need docker)
 1. Follow the instalation guide at https://buggregator.dev/#install
-2. Save the [`docker-compose.yml`](#file-docker-compose.yml)
+2. Save the [`docker-compose.yml`](#file-docker-compose-yml)
 3. Run `docker-compose up`
 
 ## WordPress
@@ -17,5 +17,5 @@ require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php'
 
 ### Dump stuff using ray
 1. Install ray in your project using composer: `composer --dev require spatie/ray`
-2. Copy [`ray.php`](#file-ray.php) to the root of your WordPress site 
+2. Copy [`ray.php`](#file-ray-php) to the root of your WordPress site 
 3. Now you can [dump to buggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
diff --git a/readme.md b/readme.md
@@ -2,7 +2,7 @@
 
 0.  (You need docker)
 1. Follow the instalation guide at https://buggregator.dev/#install
-2. Save the `docker-compose.yml` (file's further down)
+2. Save the [`docker-compose.yml`](#file-docker-compose.yml)
 3. Run `docker-compose up`
 
 ## WordPress
@@ -17,5 +17,5 @@ require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php'
 
 ### Dump stuff using ray
 1. Install ray in your project using composer: `composer --dev require spatie/ray`
-2. Copy `ray.php` (file's further down) to the root of your WordPress site 
+2. Copy [`ray.php`](#file-ray.php) to the root of your WordPress site 
 3. Now you can [dump to buggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
diff --git a/readme.md b/readme.md
@@ -2,7 +2,7 @@
 
 0.  (You need docker)
 1. Follow the instalation guide at https://buggregator.dev/#install
-2. Save the docker-compose.yml
+2. Save the `docker-compose.yml` (file's further down)
 3. Run `docker-compose up`
 
 ## WordPress
@@ -17,5 +17,5 @@ require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php'
 
 ### Dump stuff using ray
 1. Install ray in your project using composer: `composer --dev require spatie/ray`
-2. Copy `ray.php` to the root of your WordPress site.
+2. Copy `ray.php` (file's further down) to the root of your WordPress site 
 3. Now you can [dump to buggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
diff --git a/readme.md b/readme.md
@@ -18,4 +18,4 @@ require_once __DIR__ . '/wp-content/plugins/wp-sentry-integration/wp-sentry.php'
 ### Dump stuff using ray
 1. Install ray in your project using composer: `composer --dev require spatie/ray`
 2. Copy `ray.php` to the root of your WordPress site.
-3. Now you can [dump to bloggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
+3. Now you can [dump to buggregator](https://docs.buggregator.dev/config/ray.html), from your project,  using `\ray( $var );`
diff --git a/ray.php b/ray.php
@@ -1,5 +1,5 @@
 <?php
-// Save this in a file called "ray.php"
+
 
 return [
     /*
No results found