This is the official documentation for CommentBox Joomla extension.
Introduction
CommentBox is a powerful and flexible comments extension for Joomla CMS that allows administrators to configure and manage comments effectively.
Key features include:
- Integration with Joomla articles and popular third-party components.
- Advanced spam protection with CAPTCHA and anti-spam services.
- AI-powered moderation for inappropriate content filtering.
- Customizable comment editor with mentions, emojis, GIFs, and image uploads.
- User notifications and customizable email templates.
- Flexible styling options to match your site's design.
Whether you're running a blog, an online store, or a community site, CommentBox enhances user engagement and streamlines comment management.
Compatibility
CommentBox is compatible with Joomla 5.x and has been tested up to Joomla 5.2. Compatibility with future versions of Joomla! is added through extension updates.
Requirements
Your server needs to meet the Joomla! system requirements, including PHP version 8.0 or higher and MySQL 5.6 or higher. There are no additional server requirements for CommentBox.
Installation
To install CommentBox:
- Download the CommentBox package from our website.
- Log in to your Joomla administrator panel.
- Navigate to Extensions > Manage > Install.
- Upload the CommentBox package and click Upload & Install.
For more details, refer to the official Joomla documentation.
Updating
There are two ways to update this extension:
- One-Click Update:
- Navigate to System > Update Sites.
- Find the CommentBox update site and enter your account Download Key, which you can get here.
- Go to System > Update > Extensions and click Check For Updates.
- Select CommentBox from the list and click Update.
- Manual Update:
- Download the latest version of CommentBox from our website.
- Navigate to Extensions > Manage > Install.
- Upload the new package; it will automatically overwrite the old version.
Note: Always back up your site before performing manual updates. An active subscription is required to download CommentBox PRO.
Options
After installing CommentBox, it's recommended to configure the component options according to your needs. The default settings enable comments on Joomla articles with basic features.
To access the CommentBox options, navigate to Components > CommentBox > Options. The configuration options are divided into several tabs:
Integration
The Integration tab allows you to enable or disable CommentBox for specific Joomla components:
- Joomla! Articles: Enable comments on Joomla articles.
- Joomla! Articles Comment Counters: Display the number of comments on Joomla articles.
- FlexiContent Items: Integrate comments with FlexiContent.
- SP Page Builder Pages: Enable comments for pages created with SP Page Builder.
- EasyBlog Posts: Allow comments on EasyBlog posts.
- Virtuemart Products: Support commenting on Virtuemart products.
- eShop Products, HikaShop Products, PhocaCart Products: Enable comments on products for respective shopping extensions.
Use the Exclude Menu Items field to specify pages where comments should be disabled. Select the menu items from the dropdown list.
Spam Protection
The Spam Protection tab helps manage unwanted or automated comments. Options include:
CAPTCHA
CAPTCHA challenges help differentiate between human users and bots.
- Enable CAPTCHA: Choose to enable for guest users or all users.
- CAPTCHA Service: Select between ALTCHA and Google reCAPTCHA .
Anti-Spam
Anti-Spam services analyze comments for spammy patterns.
- Enable Anti-Spam: Activate for guests or all users.
- Anti-Spam Service: Select from OOPSpam, ALTCHA, Akismet, or CleanTalk.
- API Key: Provide the API key for the chosen service.
Refer to the CAPTCHA Services and Anti-Spam Services sections for detailed setup instructions.
AI Moderation
The AI Moderation tab provides settings for managing comment moderation using AI:
- AI Moderation: Enable AI-based comment moderation.
- AI Moderation Service: Select OpenAI or ModerationAPI.
- Auto-Publish Comments: Automatically publish comments that pass AI checks.
- Skip for Moderators: Allow moderators to bypass AI moderation.
- Skip for Spam: Skip AI moderation for comments flagged as spam.
- Flagged Comments Action: Choose an action (e.g., Unpublish, Trash) for flagged comments.
Refer to the AI Moderation Services section for setup details. Be aware of data privacy considerations, as comments are sent to third-party services for analysis.
Editor
The Editor tab controls features in the comment editor:
- Mentions: Enable mentioning users in comments.
- Emojis: Allow emojis in comments.
- GIFs: Enable the use of GIFs.
- Image Uploads: Allow users to upload images.
Note that features like mentions, emojis, GIFs, and image uploads require specific HTML permissions. Configure these in Global Configuration > Text Filters. Set the appropriate user groups to allow the necessary tags and attributes. The recommended "Filter Type" setting for user groups you wish to allow commenting is the "Default Forbidden List".
Visit the GIFs Setup section for GIF integration setup.
Notifications
The Notifications tab helps manage user notifications:
- New Comments: Notify administrators when a new comment is added.
- Approvals: Notify users when their comment is published.
- Replies: Notify users when someone replies to their comment.
- Flags: Notify users when their comment is flagged.
- Mentions: Notify users when they are mentioned.
Specify user groups to control who receives notifications for new comments.
Email templates for notifications can be customized via the Mail Templates section.
Style
The Style tab allows you to customize the appearance of CommentBox:
- Dark Mode: Enable dark mode support. Enable this only if your site supports dark mode.
- Brand Color: Set a custom brand color.
- Border Radius: Adjust border radius of comment elements.
- Font Family and Font Size: Customize font family and size.
- Form Size: Choose the size of the comment form (e.g., Small, Medium, Large).
Tip: Ensure CommentBox styles integrate well with your Joomla template. Preview changes to confirm compatibility.
Other
The Other tab includes additional settings:
- Frontend Moderation: Allow administrators to moderate comments from the frontend.
- Terms Checkbox: Enable a checkbox for users to accept terms before commenting.
For the Terms Checkbox, you can override the default language strings to fit your needs. You can do this in System > Language Overrides.
Permissions
The Permissions tab allows you to manage access control for different user groups. Joomla's Access Control List (ACL) system is used here. Actions include:
- Configure ACL & Options: Control access to configuration and options.
- Access Administration Interface: Restrict access to the admin interface.
- Create Comments: Allow users to submit comments.
- Edit Any Comment: Allow editing of all comments.
- Edit Own Comments: Allow users to edit their own comments.
- Edit Comment State: Control permissions to publish, unpublish, mark as spam or trash comments.
- Trash Own Comments: Allow users to trash their comments.
- Delete Any Comment: Allow deletion of any comment.
- Delete Own Comments: Allow users to delete their own comments.
- Upload Files: Permit users to upload images.
Note: By default, Joomla user permissions do not allow the "Registered" user group to create content. This applies to CommentBox too. This means that you have to change the permissions for the "Registered" user group (or any other group you wish to enable comments) after installing CommentBox.
Pages Management
Manage comments on a page-by-page basis via Components > CommentBox > Pages. This is useful for proactively disabling comments on specific pages.
Pages List View
The Pages List displays:
- Status: Enabled, Disabled, or Closed.
- Title: Page title with a link to the page.
- Published: Count of published comments.
- Unpublished: Count of unpublished comments.
- Spam: Count of spam comments.
- Trashed: Count of trashed comments.
- ID: Unique page ID.
Adding/Editing a Page
To manually add a page:
- Click New in the Pages view.
- Enter the URL of the page.
- Set the Status (Enable, Disable, Close).
- Provide a Title.
- Save the page.
This is useful for disabling comments on pages that haven't received comments yet.
CAPTCHA Services
CAPTCHA services prevent automated comments. To set up CAPTCHA:
Enabling CAPTCHA
Navigate to Components > CommentBox > Options > Spam Protection. Enable CAPTCHA for guests or all users.
Choosing a CAPTCHA Service
Available services:
- ALTCHA: Simple and accessible. No extensive configuration needed.
- reCAPTCHA: Google's service. Requires Site Key and Secret Key.
Accessibility Note: ALTCHA focuses on accessibility, suitable for users with disabilities.
Configuring ALTCHA
Select ALTCHA; no additional setup is required.
Configuring reCAPTCHA
Select reCAPTCHA and obtain keys:
- Visit Google reCAPTCHA.
- Register your site to get the Site Key and Secret Key.
- Enter these keys in CommentBox settings.
Anti-Spam Services
Anti-spam services analyze comments to block spam. To set up:
Enabling Anti-Spam
Navigate to Components > CommentBox > Options > Spam Protection. Enable Anti-Spam for guests or all users.
Choosing an Anti-Spam Service
Available services:
- OOPSpam: Uses machine learning. Note: Free tier available.
- ALTCHA: Includes spam filtering.
- Akismet: Popular spam filter. Note: May require a paid plan for commercial sites.
- CleanTalk: Cloud-based service.
Configuring OOPSpam
Obtain an API Key from OOPSpam and enter it in settings.
Configuring ALTCHA
Get an API Key from ALTCHA and enter it in settings.
Configuring Akismet
Get an API Key from Akismet and enter it in settings.
Configuring CleanTalk
Get an API Key from CleanTalk and enter it in settings.
Cost Implications: Some services may require a subscription for full features.
AI Moderation Services
AI Moderation uses advanced algorithms to detect inappropriate content. To set up:
Enabling AI Moderation
Navigate to Components > CommentBox > Options > AI Moderation and enable it.
Choosing an AI Moderation Service
Available services:
- OpenAI: Uses state-of-the-art models.
- ModerationAPI: Custom models for specific content types.
Configuring OpenAI
Obtain an API Key from OpenAI and enter it in settings.
Configuring ModerationAPI
Obtain an API Key from ModerationAPI and enter it in settings.
Cost and Rate Limits: Be aware of usage costs and rate limits.
Customizing AI Moderation Settings
You can customize:
- Auto-Publish Comments: Automatically publish approved comments.
- Flagged Comments Action: Choose to Unpublish, Trash, or Reject flagged comments.
GIFs Setup
Allow users to add GIFs to comments, powered by Tenor.
Enabling GIFs
Navigate to Components > CommentBox > Options > Editor. Enable the GIFs option.
Getting an API Key from Tenor
- Visit Tenor's Developer Page.
- Register your application to generate an API Key.
- Provide required information about your site.
- Copy the API Key provided.
Usage Policies: Review Tenor's API usage policies to ensure compliance.
Configuring Tenor API in CommentBox
Enter your Tenor API Key in Components > CommentBox > Options > Editor > Tenor API Key. Save changes to complete the setup.
Note: Currently, only Tenor is supported. Future support for other providers may be considered.
Troubleshooting
If you encounter issues:
- Comments Not Displaying: Ensure integration settings are correct and that comments are enabled for the specific page.
- CAPTCHA Not Showing: Verify CAPTCHA service configuration and API keys.
- Users Can't Upload Images: Check permissions in both CommentBox and Joomla's Text Filters.
For additional support, visit our Support Forum or contact us directly.
FAQs
Can I customize the email templates?
Yes, email templates can be customized via the Mail Templates section in the CommentBox component.
Does CommentBox support multilingual sites?
Yes, CommentBox is compatible with Joomla's multilingual features.
How do I prevent users from posting links?
Use the Global Configuration > Text Filters to block links (or any other HTML tags). Use the Content Filter in the Comments Management to search for existing comments containing links.
Comments Management
CommentBox provides a comprehensive comment management system for administrators. Access it via Components > CommentBox > Comments. The system allows you to moderate, filter, and perform bulk actions on comments.
Default View
The comments list displays all submitted comments with details:
Filtering Options
Use the Filter Options to manage comments efficiently:
Example: To find all comments marked as "Harassment" in the last month, set the AI Moderation filter to "Harassment" and the period to the last 30 days.
Actions Menu
The Actions Menu allows bulk management:
Caution: 'Trash' moves comments to the trash bin; 'Delete' permanently removes them.
Mail Templates
The Mail Templates button provides access to customizable email templates for notifications such as comment approvals, replies, and mentions. Modify these templates to match your site's tone and branding.