Merge pull request #97 from iml-it/add-wordpress

Add wordpress
iml-it · Jul 31, 2024 · 1e600ba · 1e600ba
2 parents 3d766c0 + 7f02891
commit 1e600ba
Show file tree

Hide file tree

Showing 5 changed files with 119 additions and 18 deletions.
diff --git a/docs/60_📃_PHP-client/50_Groups_of_checks.md b/docs/60_📃_PHP-client/50_Groups_of_checks.md
@@ -6,9 +6,11 @@ This is work in progress.
 
 In the folder plugins/apps are the files that contain grouped checks for a few applications.
 
-In a check script instead of writing single checks unclude the bundle:
+In a check script instead of writing single checks include the bundle:
 
 ```php
+// set variable sApproot
+$sApproot = $_SERVER['DOCUMENT_ROOT'];
 // include default checks for an application
 @require 'plugins/apps/[name-of-app].php';
 ```
diff --git a/docs/60_📃_PHP-client/60_Plugins/10_Apps/Wordpress.md b/docs/60_📃_PHP-client/60_Plugins/10_Apps/Wordpress.md
@@ -0,0 +1,86 @@
+## Wordpress
+
+### Minimal variant
+
+The following steps describe a first (and most simple) approach for a Wordpress monitoring with IML appmonitor.
+
+If you have installed ...
+
+* Wordpress directly into `[webroot]`
+* the appmonitor client in `[webroot]/appmonitor/`.
+
+Create a file `[webroot]/appmonitor/minimal.php` with this content:
+
+```php
+<?php
+$sApproot = $_SERVER['DOCUMENT_ROOT']; 
+@require 'plugins/apps/wordpress.php';
+```
+
+If wordpress was installed in a subdirectory you need to set its path, eg.
+
+```php
+$sApproot = $_SERVER['DOCUMENT_ROOT'].'/wordpress'; 
+```
+
+Then request this file, eg. <https://example.com/appmonitor/minimal.php>. You should get a JSON response.
+
+If so then add this url in Appmonitor server. Done.
+
+!!! "Note"
+    This is the most simple variant and just a quick winner.
+    You cannot customize the builtin checks or other metadata. 
+
+### Customize checks
+
+This is the preferred variant. You can...
+
+* set metadata: 
+  * name of the instance (website)
+  * customize the ttl
+  * set an app specific contact that will be informed on errors
+* add additional checks
+
+Approach:
+
+* initialize the appmonitor class
+* set wanted metadata
+* include the app plugin for wordpress
+* add your own checks
+* send the response
+
+Create a file `[webroot]/appmonitor/check-wordpress.php` with this content:
+
+```php
+<?php
+
+// ----------------------------------------------------------------------
+// initialize
+require_once('classes/appmonitor-client.class.php');
+$oMonitor = new appmonitor();
+
+// ----------------------------------------------------------------------
+// set metadata
+// $oMonitor->setWebsite('My wordpress Blog');
+// $oMonitor->setTTL(300);
+// $oMonitor->addTag('production');
+
+// ----------------------------------------------------------------------
+// include the app plugin for wordpress
+$sApproot = $_SERVER['DOCUMENT_ROOT']; 
+@require 'plugins/apps/wordpress.php';
+
+// ----------------------------------------------------------------------
+// add your custom checks
+// $oMonitor->addCheck(...)
+
+// ----------------------------------------------------------------------
+// send the response
+
+$oMonitor->setResult();
+$oMonitor->render();
+
+// ----------------------------------------------------------------------
+```
+
+Check it with <https://example.com/appmonitor/check-wordpress.php>.
diff --git a/docs/60_📃_PHP-client/60_Plugins/10_Apps/_index.md b/docs/60_📃_PHP-client/60_Plugins/10_Apps/_index.md
@@ -1,9 +1,12 @@
-# Plugins/apps folder #
+<html>
+<div class="hero">
+    <h2>Plugins/apps/ folder</h2>
+    In the folder plugins/apps are the files that contain grouped checks for a few applications.
+</div>
+</html>
 
-In the folder plugins/apps are the files that contain grouped checks for a few applications.
-
-Remark: 
+### Remark
 
 This is work in progress. Currently a few groups for products are in the repository
 
-https://github.com/iml-it/appmonitor-clients
+<https://github.com/iml-it/appmonitor-clients>
diff --git a/docs/60_📃_PHP-client/60_Plugins/20_Checks/_index.md b/docs/60_📃_PHP-client/60_Plugins/20_Checks/_index.md
@@ -1,6 +1,9 @@
-# Plugins/checks folder #
-
-In the folder plugins/checks/ are the files that contain the logic of a single check.
+<html>
+<div class="hero">
+    <h2>Plugins/checks/ folder</h2>
+    In the folder plugins/checks/ are the files that contain the logic of a single check.
+</div>
+</html>
 
 ## Included checks ##
 

diff --git a/public_html/client/index.sample.php b/public_html/client/index.sample.php
@@ -9,29 +9,33 @@
  * 
  */
 
+ // ----------------------------------------------------------------------
+// initialize
 require_once('classes/appmonitor-client.class.php');
 $oMonitor = new appmonitor();
 
-// set a name with application name and environment or hostname
-$oMonitor->setWebsite('[My CMS on host XY]');
-
-// how often the server should ask for updates
-$oMonitor->setTTL(300);
+// ----------------------------------------------------------------------
+// set metadata
+// $oMonitor->setWebsite('My wordpress Blog');
+// $oMonitor->setTTL(300);
+// $oMonitor->addTag('cms');
+// $oMonitor->addTag('production');
 
 // a general include ... the idea is to a file with the same actions on all
 // installations and hosts that can be deployed by a software delivery service 
 // (Puppet, Ansible, ...)
 @include 'general_include.php';
 
-// add any tag to add it in the filter list in the server web gui
-// $oMonitor->addTag('cms');
-// $oMonitor->addTag('production');
-
 // ----------------------------------------------------------------------
+// include the app plugin
+
+// set variable sApproot
+// $sApproot = $_SERVER['DOCUMENT_ROOT'];
 
 // include default checks for an application
 // @require 'plugins/apps/[name-of-app].php';
 
+// ----------------------------------------------------------------------
 // add a few custom checks
 // $oMonitor->addCheck(...)
 $oMonitor->addCheck(
@@ -48,8 +52,11 @@
 );
 
 // ----------------------------------------------------------------------
+// send the response
 
 $oMonitor->setResult();
 $oMonitor->render();
 
 // ----------------------------------------------------------------------
+
+// ----------------------------------------------------------------------