This documentation contains Guides and How-tos to setup and configure JoomPush on your Joomla site.
Before we begin, ensure that you have met the System Requirements in order for JoomPush to operate correctly. You may find the most basic requirements for JoomPush below:
Every information related to PHP and MySQL is presented on Joomla’s page, click here to see details
- Joomla 3.x
JoomPush runs on PHP and it requires PHP to exist on the site.
- 5.3+ and above.
JoomPush requires a minimum version of MySQL 5+
Checking System Requirements
You may review these requirements from the management system: System → System Information → PHP Settings
You can also create a very simple PHP script and include the codes below in your php file.
// This is a very simple method to load up php's settings.
SSL certificate websites
Push Notifications will work only on sites have HTTPS / SSL certificates and on Google Chrome and Mozilla Firefox latest version browsers.
How to Install
Installation and Configuration
Assuming that you have already downloaded the JoomPush package
- From the backend of your Joomla site (administration) select Extensions → Install/Uninstall.
- Click the Browse button and select the extension package on your local machine.
- Click the Upload File & Install button.
- Some extensions may provide further instructions on installation.
- Note that modules and plugins must be enabled before they will work.
There are some situations in which this procedure will not work. Sometimes you need to unzip the file locally prior to installing. If you get an error saying that the file is not in the correct format, the need to unzip is a common cause of this. After unzipping try installing the individual items. Note that the files you upload using the installer still need to be zipped.
First save the component config
- Go to administrator->Component->Joompush
- In Component option save 'Allow Guest' option
- Yes=> guest user will able to subscribe for notification. No => Only registered user will able to subscribe
Welcome Notification on Subscribe
Set 'Yes' to 'Welcome Notification on Subscribe' option to push welcome notification to new subscriber. Admin user can manage welcome notification text, message and icon from the the config. See below image for more details.
Get Google Firebase API and Secret Key
Joompush works with google firebase cloud messaging, so you need to create google firebase project to get API keys and other data.
Please refer following video to create firebase project.
To save firebase config details, go to administrator->Component->Joompush. You just need to configure google firebase parameters. Parameters details as below:Server Key:
- Firebase project cloud messaging ‘Legacy Server key’
- Firebase project Web API Key
- Firebase project cloud messaging sender id
- Firebase project id
- Default icon for push notification. Just need to add path
- Default push notification click action url.
Admin can stay updated with all the subscribers and Push notification related activities at glance.
Note: These are the ones who accept by clicking “Allow” button of the pop-up that appears on your site when the user visits it for the first time.
Subscribers will be added in the list view at the backend. You can view all the subscribers in the “Subscriber” menu at the backend
Push Notifications can be sent in Groups. You will have to select specific subscribers and add then in the new group which you will be creating.
Create new Templates
Create a Push Notification message by Adding an Icon that will be shown in the notification. You will also be able to add Title and Message Body (Max Length 235 characters). Admin has the ability to customize the icon and also the redirection path of the notification by adding a URL in it.
Once you you create a message template that will be saved in by default. These ready templates will be available every time you click “Push”. Here you will also have an option to create a new message template.
Manage all the Google Firebase related configuration from here.
Admin user can overview and manage all sent notification status.
Joompush System Plugin
Go to extensions menu in the backend then click on plugin. Search for “JoomPush”. This is the JoomPush system plugin, which is enabled by default. We would still suggest you to double check if it is enabled or not.