Filling a gap in the functionality of Content - Indexing API, this console plugin scans for items (content, contacts, tags, weblinks, and newsfeeds) that recently reached their publish_up dates, submitting them to your configured search engines. Additionally, you can now submit specific URLs via CLI.
How It Works
Two Operational Modes
-
- indexingapi:published - Scans core components for recently published items, and submits them to your configured engines.
- indexingapi:submit - Takes a single URL input and submits that URL to your configured engines.
v5.0.4
P
P
Automate with Cron
Determine your preferred interval and configure the plugin. The plugin requires hour increments, so limit your cron configuration to hour intervals. Default is 24 hours, a daily cron job. This scans your content for items published in the last 24 hours (where the publish_up date is greater than the created date).
Add this line to your server’s crontab:
0 0 * * * php /path/to/joomla/cli/joomla.php indexingapi:published
Need a different schedule? Use 0 12 * * * for noon. Adjust /path/to/joomla/ to your Joomla root path, and you are ready—consistent data, no hassle.
You can set your future publish dates, and submit them for indexing within as little as an hour of that time.
Why You Need An Indexing Cron Job
Your articles/contacts/newsfeeds/tags/weblinks - are not always intended for immediate publishing. If that publish_up date arrives at midnight while you're sleeping, it might be hours before you're awake to submit it to the search engines. This plugin takes care of that, by scanning your content at regular intervals and submitting the items which reach the publish_up date. Hands off operation through Cron.
Additionally, you might need to resubmit a URL that Content - Indexing API doesn't monitor. You can do that too using the indexingapi:submit --url="https://your-super-whammo-dyne-url"
Features
- Simple CLI Syntax: Schedule the cron, no special command line flags required
- Set The Schedule: Match the plugin cron interval with your actual cron interval and all of your configurations are done.
- Free and Native: Fully free, Joomla 5-compatible, no upsell distractions.
Will you sleep better knowing your articles hit the search engines immediately upon reaching their publish dates?
Download the Plugin
Console - Indexing API 5.0.4158
Frequently Asked Questions:
What does the Console - Indexing API plugin do?
The Console - Indexing API plugin automates the submission of recently published Joomla items (articles, contacts, tags, weblinks, and newsfeeds) to configured search engines based on their publish_up dates. It also allows manual submission of specific URLs via the command line interface (CLI).
What are the two operational modes of the plugin?
The plugin has two modes:
- indexingapi:published: Scans core Joomla components for items that have reached their publish_up date and submits them to search engines.
- indexingapi:submit: Submits a specific URL provided via the CLI to your configured search engines.
Does this plugin require any other extensions to work?
Yes, the plugin requires the Content - Indexing API plugin to be installed and enabled, with its access level set to Public (this requirement may become more flexible in Joomla 6).
How do I set up a cron job for the plugin?
To automate submissions, add a cron job to your server’s crontab. For a daily run at midnight, use:
0 0 * * * php /path/to/joomla/cli/joomla.php indexingapi:published
Replace /path/to/joomla/ with your Joomla root directory. Ensure the cron interval (e.g., 24 hours) matches the plugin’s configuration setting.
Can I customize the cron job schedule?
The plugin’s interval setting must match the cron schedule (e.g., 12 hours, 24 hours).
What types of content does the plugin scan for indexing?
The plugin scans for Joomla core components, including articles, contacts, tags, weblinks, and newsfeeds, that meet the following criteria: Published (state = 1) Access level is Public or Guest (1 or 5) publish_up date is greater than the creation date and has been reached publish_up date is within the configured interval (e.g., last 24 hours)
Can I submit a single URL for indexing?
Yes, use the indexingapi:submit command with the --url flag.
Is the plugin free to use?
Yes, Console - Indexing API is completely free, fully compatible with Joomla 5, and has no upsell or premium features.
Why do I need a cron job for indexing?
A cron job ensures that content with future publish_up dates is automatically submitted to search engines as soon as the date is reached, without manual intervention. This is especially useful for content scheduled to go live at off-hours.
How do I configure the plugin after installation?
After installing and enabling the plugin via Joomla’s administrator area (System > Manage > Plugins), set the interval (in hours) in the plugin’s configuration to match your cron job schedule (e.g., 24 hours for daily runs). Ensure the Content - Indexing API plugin is also enabled and set to Public access.
Can I use this plugin to submit multiple URLs at once?
While the indexingapi:submit command accepts a single URL, advanced users can script multiple URL submissions via the CLI. However, this should be done cautiously to avoid potential misuse, such as spamming search engines.
What happens if my cron interval doesn’t match the plugin’s configuration?
If the cron interval and plugin configuration don’t match, the plugin may miss newly published items or submit items multiple times unnecessarily. Always ensure the intervals are aligned (e.g., both set to 24 hours).
Is there a risk of over-submitting URLs to search engines?
The plugin prevents over-submission by only processing items with a publish_up date within the configured interval (e.g., last 24 hours). This avoids spamming search engines with repeated updates.
Where can I find more help or documentation?
Visit the Console - Indexing API Documentation on richeyweb.com for detailed setup and usage instructions.
Will this plugin work with Joomla 6?
The plugin is currently compatible with Joomla 5. Future updates are planned to ensure compatibility with Joomla 6, including potential improvements to access level flexibility.