The Whistleblower Plugin is an extension for Grav CMS.
Whistleblower helps you to know what happens on your site everytime by notifying you directly to your phone.
Installing the Whistleblower plugin can be done in one of three ways: The GPM (Grav Package Manager) installation method lets you quickly install the plugin with a simple terminal command, the manual method lets you do so via a zip file, and the admin method lets you do so via the Admin Plugin.
To install the plugin via the GPM, through your system's terminal (also called the command line), navigate to the root of your Grav-installation, and enter:
bin/gpm install whistleblower
This will install the Whistleblower plugin into your /user/plugins-directory within Grav. Its files can be found under /your/site/grav/user/plugins/whistleblower.
To install the plugin manually, download the zip-version of this repository and unzip it under /your/site/grav/user/plugins. Then rename the folder to whistleblower. You can find these files on GitHub or via GetGrav.org.
You should now have all the plugin files under
/your/site/grav/user/plugins/whistleblower
If you use the Admin Plugin, you can install the plugin directly by browsing the Plugins-menu and clicking on the Add button.
Before configuring this plugin, you should copy the user/plugins/whistleblower/whistleblower.yaml to user/config/plugins/whistleblower.yaml and only edit that copy.
Here is the default configuration and an explanation of available options:
enabled: true
admin_mode: true
# custom_server:
# custom_password:
endpoint: ""
events:
onUserLogin: "Someone has logged on {domain}!"
onUserLoginFailure: "Failed login attempt at {hour}"Note that if you use the Admin Plugin, a file with your configuration named whistleblower.yaml will be saved in the user/config/plugins/-folder once the configuration is saved in the Admin.
To start using the plugin you need to setup a ntfy endpoint. Make sure this is unique, since anyone could guess your endpoint and listen for all notifications.
Once setup, you can start adding any event hooks from Grav or Grav plugins and pairing them with a message you want to receive.
You can use a variety of variables to customize your messages. Such as {username} to receive the user who executed the event.
To start listening to the notifications you can either install the NTFY app available at the F-Droid Store or the Google Play Store.
Or you can choose to use the Web App.
To finish, just add the exact endpoint/topic you setup on the plugin configuration.
Thanks to Philip C. Heckel and the contributors of NTFY for making this service publicly available and free.
At Himmlisch Web we help you to develop the site of your dreams, with the exact functionality and look as you want. Contact us!